[pyreverse] updated docs for filter-mode #9806
Conversation
for more information, see https://pre-commit.ci
Codecov ReportAll modified and coverable lines are covered by tests β
Additional details and impacted files@@ Coverage Diff @@
## main #9806 +/- ##
=======================================
Coverage 95.79% 95.79%
=======================================
Files 174 174
Lines 18902 18902
=======================================
Hits 18107 18107
Misses 795 795
|
for more information, see https://pre-commit.ci
Pierre-Sassoulas
added
Documentation π
Skip news π
This comment has been minimized.
This comment has been minimized.
|
π€ According to the primer, this change has no effect on the checked open source code. π€π This comment was generated for commit 023e927 |
| @@ -0,0 +1,3 @@ | |||
| Improved clarity for pyreverse help docs after some trouble with usage, more details in linked issue | |||
There was a problem hiding this comment.
Let's remove this. I'll add the correct label so CI still passes.
| except constructor | ||
| 'OTHER' filter protected and private | ||
| attributes""", | ||
| "help": "filter attributes and functions according to <mode>. Correct modes are:" |
There was a problem hiding this comment.
Why did you decide to remove the formatting here?
DanielNoord
added
Skip news π
There was a problem hiding this comment.
Thanks for the contribution!
The addition to the help message of the 'OTHER' option value is helpful.
Maybe you have already figured it out, but in the issue you mention that -f SPECIAL_A does what you want - that is not entirely true; it is just a side effect. SPECIAL_A is not a valid option value (hence the error message you see).
pyreverse, in that case, does not crash but also not simply stick to the normal default value (PUB_ONLY), instead it simply ignores the value. If SPECIAL_A was the only value passed to this option, this is then equivalent to ALL (not filter at all).
| 'OTHER' filter protected and private | ||
| attributes""", | ||
| "help": "filter attributes and functions according to <mode>. Correct modes are:" | ||
| "'PUB_ONLY' - filter all non public attributes;" |
There was a problem hiding this comment.
PUB_ONLY is the default, and thus we should not remove this information from the help message.
Type of Changes
Description
Improved clarity for pyreverse help docs after some trouble with usage, more details in linked issue
Closes #9805