Tweaked the CLI help (#2).

Author: simon-ritchie

README.md

@@ -268,10 +268,10 @@ The following arguments are provided. Only `--path` argument is required, other
                         notebook. If not, Python module will be checked.
   -f IGNORE_FUNC_NAME_SUFFIX_LIST, --ignore_func_name_suffix_list IGNORE_FUNC_NAME_SUFFIX_LIST
                         A suffix list of function name conditions to ignore.
-                        e.g., test_,sample_ Comma separated string is
+                        e.g., test_,sample_. Comma separated string is
                         acceptable.
   -i IGNORE_INFO_ID_LIST, --ignore_info_id_list IGNORE_INFO_ID_LIST
-                        List of IDs to ignore lint checking. e.g, 1,2,3 Comma
+                        List of IDs to ignore lint checking. e.g, 1,2,3. Comma
                         separated integer is acceptable.
   -o, --enable_default_or_optional_doc_check
                         If specified, the `default` and `optional` stringin

numdoclint/cli.py

@@ -188,7 +188,7 @@ def main(args=None, return_list=False):
     parser.add_argument(
         '-r', '--check_recursively',
         action='store_true',
-        help='If specified, check files recursively.'
+        help='If specified, check files recursively. '
              'In that case, you need to specify the directory '
              'in the path argument.')
     parser.add_argument(
@@ -201,19 +201,19 @@ def main(args=None, return_list=False):
         type=_get_list_of_str_from_csv,
         default='',
         help='A suffix list of function name conditions to ignore.'
-             '\ne.g., test_,sample_'
+             '\ne.g., test_,sample_.'
              '\nComma separated string is acceptable.')
     parser.add_argument(
         '-i', '--ignore_info_id_list',
         type=_get_list_of_int_from_csv,
         default='',
         help='List of IDs to ignore lint checking.'
-             '\ne.g, 1,2,3'
+             '\ne.g, 1,2,3.'
              '\nComma separated integer is acceptable.')
     parser.add_argument(
         '-o', '--enable_default_or_optional_doc_check',
         action='store_true',
-        help='If specified, the `default` and `optional` string'
+        help='If specified, the `default` and `optional` string '
              'in docstring will be checked.')
     parser.add_argument(
         '-d', '--skip_decorator_name_list',