Better document --docstring-length option and add it to the readme

PyCQA · Feb 24, 2021 · 494ec4d · 494ec4d
1 parent 99099d5
commit 494ec4d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -166,6 +166,8 @@ Below is the help output::
                             in a mess
       --range line line     apply docformatter to docstrings between these lines;
                             line numbers are indexed at 1
+      --docstring-length length length
+                            apply docformatter to docstrings of given length range
       --version             show program's version number and exit
 
 

diff --git a/docformatter.py b/docformatter.py
@@ -665,7 +665,7 @@ def _main(argv, standard_out, standard_error, standard_in):
                         dest='length_range',
                         default=None, type=int, nargs=2,
                         help='apply docformatter to docstrings of given '
-                             'length')
+                             'length range')
     parser.add_argument('--version', action='version',
                         version='%(prog)s ' + __version__)
     parser.add_argument('files', nargs='+',