diff --git a/doc/whatsnew/fragments/9805.other b/doc/whatsnew/fragments/9805.other new file mode 100644 index 0000000000..6f0eb1f2c3 --- /dev/null +++ b/doc/whatsnew/fragments/9805.other @@ -0,0 +1,3 @@ +Improved clarity for pyreverse help docs after some trouble with usage, more details in linked issue + +Closes #9805 diff --git a/pylint/pyreverse/main.py b/pylint/pyreverse/main.py index 3ba0b6c77d..67fe751e64 100644 --- a/pylint/pyreverse/main.py +++ b/pylint/pyreverse/main.py @@ -56,15 +56,11 @@ "type": "string", "action": "store", "metavar": "", - "help": """filter attributes and functions according to - . Correct modes are : - 'PUB_ONLY' filter all non public attributes - [DEFAULT], equivalent to PRIVATE+SPECIAL_A - 'ALL' no filter - 'SPECIAL' filter Python special functions - except constructor - 'OTHER' filter protected and private - attributes""", + "help": "filter attributes and functions according to . Correct modes are:" + "'PUB_ONLY' - filter all non public attributes;" + "'ALL' - no filter;" + "'SPECIAL' - filter Python special functions except constructor;" + "'OTHER' - filter protected and private attributes, but not special functions;", }, ), ( @@ -76,8 +72,8 @@ "type": "csv", "dest": "classes", "default": None, - "help": "create a class diagram with all classes related to ;\ - this uses by default the options -ASmy", + "help": "create a class diagram with all classes related to ;" + "this uses by default the options -ASmy", }, ), ( @@ -174,12 +170,10 @@ "default": "dot", "metavar": "", "type": "string", - "help": ( - "create a *. output file if format is available. Available " - f"formats are: {', '.join(DIRECTLY_SUPPORTED_FORMATS)}. Any other " - f"format will be tried to create by means of the 'dot' command line " - f"tool, which requires a graphviz installation." - ), + "help": "create a *. output file if format is available. Available " + f"formats are: {', '.join(DIRECTLY_SUPPORTED_FORMATS)}. Any other " + f"format will be tried to create by means of the 'dot' command line " + f"tool, which requires a graphviz installation.", }, ), (