@@ -136,66 +136,66 @@ def get_docstring_coverage(
136136 ignore_names : Tuple [List [str ], ...] = (),
137137) -> Tuple [Dict , Dict ]:
138138 """Checks contents of `filenames` for missing docstrings, and produces a report
139- detailing docstring status.
139+ detailing docstring status.
140140
141- *Note*:
142- For a method with a more expressive return type,
143- you may want to try the experimental `docstr_coverage.analyze`
144- function.
141+ *Note*:
142+ For a method with a more expressive return type,
143+ you may want to try the experimental `docstr_coverage.analyze`
144+ function.
145145
146- Parameters
147- ----------
148- filenames: List
149- List of filename strings that are absolute or relative paths
150- skip_magic: Boolean, default=False
151- If True, skips all magic methods (double-underscore-prefixed),
152- except '__init__' and does not include them in the report
153- skip_file_docstring: Boolean, default=False
154- If True, skips check for a module-level docstring
155- skip_init: Boolean, default=False
156- If True, skips methods named '__init__' and does not include
157- them in the report
158- skip_class_def: Boolean, default=False
159- If True, skips class definitions and does not include them in the report.
160- If this is True, the class's methods will still be checked
161- skip_private: Boolean, default=False
162- If True, skips function definitions beginning with a single underscore and does
163- not include them in the report.
164- verbose: Int in [0, 1, 2, 3], default=0
165- 0) No printing.
166- 1) Print total stats only.
167- 2) Print stats for all files.
168- 3) Print missing docstrings for all files.
169- ignore_names: Tuple[List[str], ...], default=()
170- Patterns to ignore when checking documentation. Each list in `ignore_names` defines a
171- different pattern to be ignored. The first element in each list is the regular
172- expression for matching filenames. All remaining arguments in each list are
173- regexes for matching names of functions/classes. A node is ignored if it
174- matches the filename regex and at least one of the remaining regexes
175-
176- Returns
177- -------
178- Dict
179- Links filename keys to a dict of stats for that filename. Example:
180-
181- >>> {
182- ... '<filename>': {
183- ... 'missing': ['<method_or_class_name>', '...'],
184- ... 'module_doc': '<Boolean>',
185- ... 'missing_count': '<missing_count int>',
186- ... 'needed_count': '<needed_docstrings_count int>',
187- ... 'coverage': '<percent_of_coverage float>',
188- ... 'empty': '<Boolean>'
189- ... }, ...
190- ... }
191- Dict
192- Total summary stats for all files analyzed. Example:
193-
194- >>> {
195- ... 'missing_count': '<total_missing_count int>',
196- ... 'needed_count': '<total_needed_docstrings_count int>',
197- ... 'coverage': '<total_percent_of_coverage float>'
198- ... }"""
146+ Parameters
147+ ----------
148+ filenames: List
149+ List of filename strings that are absolute or relative paths
150+ skip_magic: Boolean, default=False
151+ If True, skips all magic methods (double-underscore-prefixed),
152+ except '__init__' and does not include them in the report
153+ skip_file_docstring: Boolean, default=False
154+ If True, skips check for a module-level docstring
155+ skip_init: Boolean, default=False
156+ If True, skips methods named '__init__' and does not include
157+ them in the report
158+ skip_class_def: Boolean, default=False
159+ If True, skips class definitions and does not include them in the report.
160+ If this is True, the class's methods will still be checked
161+ skip_private: Boolean, default=False
162+ If True, skips function definitions beginning with a single underscore and does
163+ not include them in the report.
164+ verbose: Int in [0, 1, 2, 3], default=0
165+ 0) No printing.
166+ 1) Print total stats only.
167+ 2) Print stats for all files.
168+ 3) Print missing docstrings for all files.
169+ ignore_names: Tuple[List[str], ...], default=()
170+ Patterns to ignore when checking documentation. Each list in `ignore_names` defines a
171+ different pattern to be ignored. The first element in each list is the regular
172+ expression for matching filenames. All remaining arguments in each list are
173+ regexes for matching names of functions/classes. A node is ignored if it
174+ matches the filename regex and at least one of the remaining regexes
175+
176+ Returns
177+ -------
178+ Dict
179+ Links filename keys to a dict of stats for that filename. Example:
180+
181+ >>> {
182+ ... '<filename>': {
183+ ... 'missing': ['<method_or_class_name>', '...'],
184+ ... 'module_doc': '<Boolean>',
185+ ... 'missing_count': '<missing_count int>',
186+ ... 'needed_count': '<needed_docstrings_count int>',
187+ ... 'coverage': '<percent_of_coverage float>',
188+ ... 'empty': '<Boolean>'
189+ ... }, ...
190+ ... }
191+ Dict
192+ Total summary stats for all files analyzed. Example:
193+
194+ >>> {
195+ ... 'missing_count': '<total_missing_count int>',
196+ ... 'needed_count': '<total_needed_docstrings_count int>',
197+ ... 'coverage': '<total_percent_of_coverage float>'
198+ ... }"""
199199 ignore_config = IgnoreConfig (
200200 skip_magic = skip_magic ,
201201 skip_file_docstring = skip_file_docstring ,
0 commit comments