Fix word mistake (#14).

Author: simon-ritchie

README.md

@@ -136,12 +136,12 @@ If you only need lint result list, and not necessary standard output, then set v
 
 ### Ignore specified functions
 
-If you want to skip functions with a specific suffix, set suffix names to the `skip_decorator_name_list` argument (default is `[test_]`).
+If you want to skip functions with a specific prefix, set prefix names to the `skip_decorator_name_list` argument (default is `[test_]`).
 
 ```py
 >>> lint_info_list = numdoclint.check_python_module(
 ...     py_module_path='../pandas/pandas/core/arrays/array_.py',
-...     ignore_func_name_suffix_list=['test_', '_main', '__init__'])
+...     ignore_func_name_prefix_list=['test_', '_main', '__init__'])
 ```
 
 ### Ignore specified IDs check
@@ -244,7 +244,7 @@ check_result_list = numdoclint.check_jupyter_notebook_recursively(
     dir_path='./sample_dir/')
 ```
 
-`ignore_func_name_suffix_list`, `ignore_info_id_list`, and `enable_default_or_optional_doc_check` arguments described above are also available.
+`ignore_func_name_prefix_list`, `ignore_info_id_list`, and `enable_default_or_optional_doc_check` arguments described above are also available.
 
 ## Command line interface
 
@@ -266,8 +266,8 @@ The following arguments are provided. Only `--path` argument is required, other
                         argument.
   -j, --is_jupyter      If specified, check target will become Jupyter
                         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.
+  -f IGNORE_FUNC_NAME_PREFIX_LIST, --ignore_func_name_prefix_list IGNORE_FUNC_NAME_PREFIX_LIST
+                        A prefix list of function name conditions to ignore.
                         e.g., test_,sample_. Comma separated string is
                         acceptable.
   -i IGNORE_INFO_ID_LIST, --ignore_info_id_list IGNORE_INFO_ID_LIST

numdoclint/__init__.py

@@ -17,4 +17,4 @@
                                   check_python_module,
                                   check_python_module_recursively)
 
-__version__ = '0.0.11'
+__version__ = '0.0.12'

numdoclint/cli.py

@@ -94,7 +94,7 @@ def _exec_numdoclint(
         path,
         check_recursively,
         is_jupyter,
-        ignore_func_name_suffix_list,
+        ignore_func_name_prefix_list,
         ignore_info_id_list,
         enable_default_or_optional_doc_check,
         skip_decorator_name_list):
@@ -111,8 +111,8 @@ def _exec_numdoclint(
     is_jupyter : bool
         If True, check target will become Jupyter notebook.
         If not, Python module will be checked.
-    ignore_func_name_suffix_list : list of str
-        A suffix list of function name conditions to ignore.
+    ignore_func_name_prefix_list : list of str
+        A prefix list of function name conditions to ignore.
     ignore_info_id_list : list of int
         List of IDs to ignore lint checking.
     enable_default_or_optional_doc_check : bool
@@ -132,14 +132,14 @@ def _exec_numdoclint(
         if not check_recursively:
             info_list = numdoclint.check_python_module(
                 py_module_path=path,
-                ignore_func_name_suffix_list=ignore_func_name_suffix_list,
+                ignore_func_name_prefix_list=ignore_func_name_prefix_list,
                 ignore_info_id_list=ignore_info_id_list,
                 enable_default_or_optional_doc_check=enable_def_or_opt_check,
                 skip_decorator_name_list=skip_decorator_name_list)
             return info_list
         info_list = numdoclint.check_python_module_recursively(
             dir_path=path,
-            ignore_func_name_suffix_list=ignore_func_name_suffix_list,
+            ignore_func_name_prefix_list=ignore_func_name_prefix_list,
             ignore_info_id_list=ignore_info_id_list,
             enable_default_or_optional_doc_check=enable_def_or_opt_check,
             skip_decorator_name_list=skip_decorator_name_list)
@@ -148,13 +148,13 @@ def _exec_numdoclint(
     if not check_recursively:
         info_list = numdoclint.check_jupyter_notebook(
             notebook_path=path,
-            ignore_func_name_suffix_list=ignore_func_name_suffix_list,
+            ignore_func_name_prefix_list=ignore_func_name_prefix_list,
             ignore_info_id_list=ignore_info_id_list,
             enable_default_or_optional_doc_check=enable_def_or_opt_check)
         return info_list
     info_list = numdoclint.check_jupyter_notebook_recursively(
         dir_path=path,
-        ignore_func_name_suffix_list=ignore_func_name_suffix_list,
+        ignore_func_name_prefix_list=ignore_func_name_prefix_list,
         ignore_info_id_list=ignore_info_id_list,
         enable_default_or_optional_doc_check=enable_def_or_opt_check)
     return info_list
@@ -197,10 +197,10 @@ def main(args=None, return_list=False):
         help='If specified, check target will become Jupyter notebook. '
              'If not, Python module will be checked.')
     parser.add_argument(
-        '-f', '--ignore_func_name_suffix_list',
+        '-f', '--ignore_func_name_prefix_list',
         type=_get_list_of_str_from_csv,
         default='',
-        help='A suffix list of function name conditions to ignore.'
+        help='A prefix list of function name conditions to ignore.'
              '\ne.g., test_,sample_.'
              '\nComma separated string is acceptable.')
     parser.add_argument(
@@ -238,7 +238,7 @@ def main(args=None, return_list=False):
         path=args.path,
         check_recursively=args.check_recursively,
         is_jupyter=args.is_jupyter,
-        ignore_func_name_suffix_list=args.ignore_func_name_suffix_list,
+        ignore_func_name_prefix_list=args.ignore_func_name_prefix_list,
         ignore_info_id_list=args.ignore_info_id_list,
         enable_default_or_optional_doc_check=enable_def_or_opt_check,
         skip_decorator_name_list=args.skip_decorator_name_list,

numdoclint/helper.py

@@ -16,7 +16,7 @@
 ]
 ARG_NAME_LIST_TO_IGNORE.extend(ARGS_OR_KWARGS_NAME_LIST)
 
-ADDITIONAL_INFO_SUFFIX_LIST = [
+ADDITIONAL_INFO_PREFIX_LIST = [
     '.. versionadded',
     '.. deprecated',
     '.. versionchanged',
@@ -912,8 +912,8 @@ def _is_additional_info_str(target_str):
         will be set.
     """
     target_str = target_str.strip()
-    for additional_info_suffix in ADDITIONAL_INFO_SUFFIX_LIST:
-        if target_str.startswith(additional_info_suffix):
+    for additional_info_prefix in ADDITIONAL_INFO_PREFIX_LIST:
+        if target_str.startswith(additional_info_prefix):
             return True
     return False
 
@@ -1053,11 +1053,11 @@ def _get_return_value_docstring(docstring, drop_additional_info=True):
     docstring = docstring.strip()
 
     if drop_additional_info:
-        for additional_info_suffix in ADDITIONAL_INFO_SUFFIX_LIST:
-            is_in = additional_info_suffix in docstring
+        for additional_info_prefix in ADDITIONAL_INFO_PREFIX_LIST:
+            is_in = additional_info_prefix in docstring
             if not is_in:
                 continue
-            docstring = docstring.split(additional_info_suffix)[0]
+            docstring = docstring.split(additional_info_prefix)[0]
             docstring = docstring.strip()
 
     if not docstring.startswith('    '):

numdoclint/jupyter_notebook.py

@@ -19,7 +19,7 @@
 
 
 def check_jupyter_notebook(
-        notebook_path, verbose=1, ignore_func_name_suffix_list=['test_'],
+        notebook_path, verbose=1, ignore_func_name_prefix_list=['test_'],
         ignore_info_id_list=[],
         enable_default_or_optional_doc_check=False):
     """
@@ -33,11 +33,11 @@ def check_jupyter_notebook(
         Log settings of stdout. Specify one of the following numbers:
         - 0 -> Do not output log.
         - 1 -> Output the check result.
-    ignore_func_name_suffix_list : list of str, default ['test_']
-        A suffix list of function name conditions to ignore.
+    ignore_func_name_prefix_list : list of str, default ['test_']
+        A prefix list of function name conditions to ignore.
     ignore_info_id_list : list of int, default []
         List of IDs to ignore lint checking. A constant with a
-        suffix of `INFO_ID_` can be specified.
+        prefix of `INFO_ID_` can be specified.
     enable_default_or_optional_doc_check : bool, default False
         If True specified, the `default` and `optional` string
         in docstring will be checked.
@@ -82,7 +82,7 @@ def check_jupyter_notebook(
             notebook_path=notebook_path,
             code_cell_idx=i,
             code_cell_str=code_cell_str,
-            ignore_func_name_suffix_list=ignore_func_name_suffix_list,
+            ignore_func_name_prefix_list=ignore_func_name_prefix_list,
             ignore_info_id_list=ignore_info_id_list,
             enable_default_or_optional_doc_check=enable_def_or_opt_check)
         info_list.extend(info_list_unit)
@@ -91,7 +91,7 @@ def check_jupyter_notebook(
 
 
 def check_jupyter_notebook_recursively(
-        dir_path, verbose=1, ignore_func_name_suffix_list=['test_'],
+        dir_path, verbose=1, ignore_func_name_prefix_list=['test_'],
         ignore_info_id_list=[],
         enable_default_or_optional_doc_check=False):
     """
@@ -105,11 +105,11 @@ def check_jupyter_notebook_recursively(
         Log settings of stdout. Specify one of the following numbers:
         - 0 -> Do not output log.
         - 1 -> Output the check result.
-    ignore_func_name_suffix_list : list of str, default ['test_']
-        A suffix list of function name conditions to ignore.
+    ignore_func_name_prefix_list : list of str, default ['test_']
+        A prefix list of function name conditions to ignore.
     ignore_info_id_list : list of int, default []
         List of IDs to ignore lint checking. A constant with a
-        suffix of `INFO_ID_` can be specified.
+        prefix of `INFO_ID_` can be specified.
     enable_default_or_optional_doc_check : bool, default False
         If True specified, the `default` and `optional` string
         in docstring will be checked.
@@ -135,15 +135,15 @@ def check_jupyter_notebook_recursively(
         dir_path=dir_path,
         info_list=[],
         verbose=verbose,
-        ignore_func_name_suffix_list=ignore_func_name_suffix_list,
+        ignore_func_name_prefix_list=ignore_func_name_prefix_list,
         ignore_info_id_list=ignore_info_id_list,
         enable_default_or_optional_doc_check=enable_def_or_opt_check)
     return info_list
 
 
 def _check_jupyter_notebook_recursively(
         dir_path, info_list, verbose,
-        ignore_func_name_suffix_list, ignore_info_id_list,
+        ignore_func_name_prefix_list, ignore_info_id_list,
         enable_default_or_optional_doc_check):
     """
     Check docstring of Jupyter notebook recursively.
@@ -158,11 +158,11 @@ def _check_jupyter_notebook_recursively(
         Log settings of stdout. Specify one of the following numbers:
         - 0 -> Do not output log.
         - 1 -> Output the check result.
-    ignore_func_name_suffix_list : list of str
-        A suffix list of function name conditions to ignore.
+    ignore_func_name_prefix_list : list of str
+        A prefix list of function name conditions to ignore.
     ignore_info_id_list : list of int
         List of IDs to ignore lint checking. A constant with a
-        suffix of `INFO_ID_` can be specified.
+        prefix of `INFO_ID_` can be specified.
     enable_default_or_optional_doc_check : bool
         If True specified, the `default` and `optional` string
         in docstring will be checked.
@@ -188,7 +188,7 @@ def _check_jupyter_notebook_recursively(
                 dir_path=path,
                 info_list=info_list,
                 verbose=verbose,
-                ignore_func_name_suffix_list=ignore_func_name_suffix_list,
+                ignore_func_name_prefix_list=ignore_func_name_prefix_list,
                 ignore_info_id_list=ignore_info_id_list,
                 enable_default_or_optional_doc_check=enable_def_or_opt_check)
             continue
@@ -197,7 +197,7 @@ def _check_jupyter_notebook_recursively(
         unit_info_list = check_jupyter_notebook(
             notebook_path=path,
             verbose=verbose,
-            ignore_func_name_suffix_list=ignore_func_name_suffix_list,
+            ignore_func_name_prefix_list=ignore_func_name_prefix_list,
             ignore_info_id_list=ignore_info_id_list,
             enable_default_or_optional_doc_check=enable_def_or_opt_check)
         info_list.extend(unit_info_list)
@@ -246,7 +246,7 @@ def _print_info_list(info_list, verbose):
 
 def _check_unit_code_cell_str(
         notebook_path, code_cell_idx, code_cell_str,
-        ignore_func_name_suffix_list, ignore_info_id_list,
+        ignore_func_name_prefix_list, ignore_info_id_list,
         enable_default_or_optional_doc_check):
     """
     Check the single code cell.
@@ -259,11 +259,11 @@ def _check_unit_code_cell_str(
         Index of target code cell.
     code_cell_str : str
         Code string of target cell.
-    ignore_func_name_suffix_list : list of str
-        A suffix list of function name conditions to ignore.
+    ignore_func_name_prefix_list : list of str
+        A prefix list of function name conditions to ignore.
     ignore_info_id_list : list of int
         List of IDs to ignore lint checking. A constant with a
-        suffix of `INFO_ID_` can be specified.
+        prefix of `INFO_ID_` can be specified.
     enable_default_or_optional_doc_check : bool
         If True specified, the `default` and `optional` string
         in docstring will be checked.
@@ -289,7 +289,7 @@ def _check_unit_code_cell_str(
     for func_name in func_name_list:
         is_func_name_to_ignore = py_module.is_func_name_to_ignore(
             func_name=func_name,
-            ignore_func_name_suffix_list=ignore_func_name_suffix_list)
+            ignore_func_name_prefix_list=ignore_func_name_prefix_list)
         if is_func_name_to_ignore:
             continue
         single_func_info_list = py_module.get_single_func_info_list(