@@ -7,19 +7,34 @@ class IgnoreConfig:
77
88 def __init__ (
99 self ,
10+ ignore_names : Tuple [List [str ], ...] = (),
1011 skip_magic : bool = False ,
1112 skip_file_docstring : bool = False ,
1213 skip_init : bool = False ,
1314 skip_class_def : bool = False ,
1415 skip_private : bool = False ,
15- ignore_names : Tuple [List [str ], ...] = (),
16+ skip_property : bool = False ,
17+ skip_setter : bool = True ,
18+ skip_deleter : bool = True ,
1619 ):
20+ self ._ignore_names = ignore_names
1721 self ._skip_magic = skip_magic
1822 self ._skip_file_docstring = skip_file_docstring
1923 self ._skip_init = skip_init
2024 self ._skip_class_def = skip_class_def
2125 self ._skip_private = skip_private
22- self ._ignore_names = ignore_names
26+ self ._skip_property = skip_property
27+ self ._skip_setter = skip_setter
28+ self ._skip_deleter = skip_deleter
29+
30+ @property
31+ def ignore_names (self ):
32+ """Patterns to ignore when checking documentation. Each list in `ignore_names` defines a
33+ different pattern to be ignored. The first element in each list is the regular expression
34+ for matching filenames. All remaining arguments in each list are regexes for matching names
35+ of functions/classes. A node is ignored if it matches the filename regex and at least one
36+ of the remaining regexes"""
37+ return self ._ignore_names
2338
2439 @property
2540 def skip_magic (self ):
@@ -45,15 +60,20 @@ def skip_class_def(self):
4560
4661 @property
4762 def skip_private (self ):
48- """If True, skip function definitions beginning with a single underscore and exclude them
49- from the report"""
63+ """If True, skip function definitions beginning with a single underscore."""
5064 return self ._skip_private
5165
5266 @property
53- def ignore_names (self ):
54- """Patterns to ignore when checking documentation. Each list in `ignore_names` defines a
55- different pattern to be ignored. The first element in each list is the regular expression
56- for matching filenames. All remaining arguments in each list are regexes for matching names
57- of functions/classes. A node is ignored if it matches the filename regex and at least one
58- of the remaining regexes"""
59- return self ._ignore_names
67+ def skip_property (self ):
68+ """If True, skip nodes with `@property` decorator."""
69+ return self ._skip_property
70+
71+ @property
72+ def skip_setter (self ):
73+ """If True, skip nodes with `@setter` decorator."""
74+ return self ._skip_setter
75+
76+ @property
77+ def skip_deleter (self ):
78+ """If True, skip nodes with `@deleter` decorator."""
79+ return self ._skip_deleter
0 commit comments