File tree Expand file tree Collapse file tree 2 files changed +5
-2
lines changed
pydocstringformatter/utils Expand file tree Collapse file tree 2 files changed +5
-2
lines changed Original file line number Diff line number Diff line change @@ -8,8 +8,8 @@ Use `pre-commit install` to install the pre-commit hook for the repository.
88
99- Implement a Formatter by inheriting from `` pydocstringformatter.formatting.Formatter ``
1010- Add your new formatter to `` pydocstringformatter.formatting.FORMATTERS ``
11- - Create a clear docstring because this will be user-facing: it's what will be seen in the help.
12- - Choose a proper name because this will be user-facing: the name will be used for option of the CLI .
11+ - Write a clear docstring because this will be user-facing: it's what will be seen in the help message for the formatters command line option .
12+ - Choose a proper name because this will be user-facing: the name will be used to turn the checker on and off via the command line or config files .
1313
1414### Testing
1515
Original file line number Diff line number Diff line change @@ -20,13 +20,16 @@ def _parse_command_line_arguments(
2020def _register_arguments (version : str ) -> argparse .ArgumentParser :
2121 """Create an argument parser and add all supported arguments"""
2222 parser = argparse .ArgumentParser (prog = "pydocstringformatter" )
23+
2324 parser .add_argument ("files" , nargs = "*" , type = str )
25+
2426 parser .add_argument (
2527 "-w" ,
2628 "--write" ,
2729 action = "store_true" ,
2830 help = "Write the changes to file instead of printing the files to stdout" ,
2931 )
32+
3033 parser .add_argument (
3134 "-v" ,
3235 "--version" ,
You can’t perform that action at this time.
0 commit comments