Skip to content

Commit

Permalink
Fix help text (#102)
Browse files Browse the repository at this point in the history
  • Loading branch information
blablatdinov authored Sep 23, 2024
1 parent db539ba commit a2e4c27
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions ondivi/entry.py
Original file line number Diff line number Diff line change
Expand Up @@ -102,21 +102,21 @@ def cli(baseline: str, violation_format: str, only_violations: bool) -> None:
'--format',
'violation_format',
default='{filename}:{line_num:d}{other}',
help='\b\n{0}'.format('\n'.join([
'Template for parsing linter messages. The template should include the following named parts:',
'{filename} The name of the file with the error/warning',
'{line_num} The line number with the error/warning (integer)',
'Example usage:',
'--format "{filename}:{line_num:d}{other}"',
'In this example, the linter message',
'"src/app_types/listable.py:23:1: UP035 Import from collections.abc instead: Sequence"',
'will be recognized and parsed into the following components:',
' - filename: "src/app_types/listable.py"',
' - line_num: 23',
' - other: :1: UP035 Import from collections.abc instead: Sequence"',
'Ensure that the template matches the format of the messages generated by your linter.',
help=''.join([
'Template for parsing linter messages. The template should include the following named parts:\n\n',
'{filename} The name of the file with the error/warning\n',
'{line_num} The line number with the error/warning (integer)\n\n',
'Example usage:\n\n',
'--format "{filename}:{line_num:d}{other}"\n\n',
'In this example, the linter message\n\n',
'"src/app_types/listable.py:23:1: UP035 Import from collections.abc instead: Sequence"\n\n',
'will be recognized and parsed into the following components:\n\n',
' - filename: "src/app_types/listable.py"\n\t\t\t\t',
' - line_num: 23\n\t\t\t\t\t',
' - other: :1: UP035 Import from collections.abc instead: Sequence"\n\n',
'Ensure that the template matches the format of the messages generated by your linter.\n\t\t\t\t',
'(default: "{filename}:{line_num:d}{other}")',
])),
]),
)
@click.option(
'--only-violations',
Expand Down

0 comments on commit a2e4c27

Please sign in to comment.