docsig 0.85.2__tar.gz → 0.86.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {docsig-0.85.2 → docsig-0.86.0}/PKG-INFO +7 -7
- {docsig-0.85.2 → docsig-0.86.0}/README.rst +6 -6
- {docsig-0.85.2 → docsig-0.86.0}/docsig/_config.py +0 -7
- {docsig-0.85.2 → docsig-0.86.0}/docsig/_main.py +0 -1
- {docsig-0.85.2 → docsig-0.86.0}/docsig/_report.py +4 -4
- {docsig-0.85.2 → docsig-0.86.0}/docsig/_version.py +1 -1
- {docsig-0.85.2 → docsig-0.86.0}/pyproject.toml +2 -7
- {docsig-0.85.2 → docsig-0.86.0}/LICENSE +0 -0
- {docsig-0.85.2 → docsig-0.86.0}/docsig/__init__.py +0 -0
- {docsig-0.85.2 → docsig-0.86.0}/docsig/__main__.py +0 -0
- {docsig-0.85.2 → docsig-0.86.0}/docsig/_check.py +0 -0
- {docsig-0.85.2 → docsig-0.86.0}/docsig/_core.py +0 -0
- {docsig-0.85.2 → docsig-0.86.0}/docsig/_decorators.py +0 -0
- {docsig-0.85.2 → docsig-0.86.0}/docsig/_directives.py +0 -0
- {docsig-0.85.2 → docsig-0.86.0}/docsig/_files.py +0 -0
- {docsig-0.85.2 → docsig-0.86.0}/docsig/_hooks.py +0 -0
- {docsig-0.85.2 → docsig-0.86.0}/docsig/_module.py +0 -0
- {docsig-0.85.2 → docsig-0.86.0}/docsig/_parsers.py +0 -0
- {docsig-0.85.2 → docsig-0.86.0}/docsig/_stub.py +0 -0
- {docsig-0.85.2 → docsig-0.86.0}/docsig/_utils.py +0 -0
- {docsig-0.85.2 → docsig-0.86.0}/docsig/messages.py +0 -0
- {docsig-0.85.2 → docsig-0.86.0}/docsig/plugin/__init__.py +0 -0
- {docsig-0.85.2 → docsig-0.86.0}/docsig/plugin/_flake8.py +0 -0
- {docsig-0.85.2 → docsig-0.86.0}/docsig/plugin/_validate_pyproject.py +0 -0
- {docsig-0.85.2 → docsig-0.86.0}/docsig/py.typed +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: docsig
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.86.0
|
|
4
4
|
Summary: Check signature params for proper documentation
|
|
5
5
|
License: MIT
|
|
6
6
|
License-File: LICENSE
|
|
@@ -195,7 +195,7 @@ ensure your installation has registered `docsig`
|
|
|
195
195
|
.. code-block:: console
|
|
196
196
|
|
|
197
197
|
$ flake8 --version
|
|
198
|
-
7.3.0 (docsig: 0.
|
|
198
|
+
7.3.0 (docsig: 0.86.0, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.10.19 on Darwin
|
|
199
199
|
|
|
200
200
|
And now use `flake8` to lint your files
|
|
201
201
|
|
|
@@ -212,9 +212,9 @@ avoid any potential conflicts with other plugins
|
|
|
212
212
|
.. code-block:: ini
|
|
213
213
|
|
|
214
214
|
[flake8]
|
|
215
|
-
sig-check-dunders =
|
|
216
|
-
sig-check-overridden =
|
|
217
|
-
sig-check-protected =
|
|
215
|
+
sig-check-dunders = true
|
|
216
|
+
sig-check-overridden = true
|
|
217
|
+
sig-check-protected = true
|
|
218
218
|
|
|
219
219
|
..
|
|
220
220
|
end flake8
|
|
@@ -281,7 +281,7 @@ Standalone
|
|
|
281
281
|
|
|
282
282
|
repos:
|
|
283
283
|
- repo: https://github.com/jshwi/docsig
|
|
284
|
-
rev: v0.
|
|
284
|
+
rev: v0.86.0
|
|
285
285
|
hooks:
|
|
286
286
|
- id: docsig
|
|
287
287
|
args:
|
|
@@ -300,7 +300,7 @@ or integrated with ``flake8``
|
|
|
300
300
|
hooks:
|
|
301
301
|
- id: flake8
|
|
302
302
|
additional_dependencies:
|
|
303
|
-
- docsig==0.
|
|
303
|
+
- docsig==0.86.0
|
|
304
304
|
args:
|
|
305
305
|
- "--sig-check-class"
|
|
306
306
|
- "--sig-check-dunders"
|
|
@@ -166,7 +166,7 @@ ensure your installation has registered `docsig`
|
|
|
166
166
|
.. code-block:: console
|
|
167
167
|
|
|
168
168
|
$ flake8 --version
|
|
169
|
-
7.3.0 (docsig: 0.
|
|
169
|
+
7.3.0 (docsig: 0.86.0, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.10.19 on Darwin
|
|
170
170
|
|
|
171
171
|
And now use `flake8` to lint your files
|
|
172
172
|
|
|
@@ -183,9 +183,9 @@ avoid any potential conflicts with other plugins
|
|
|
183
183
|
.. code-block:: ini
|
|
184
184
|
|
|
185
185
|
[flake8]
|
|
186
|
-
sig-check-dunders =
|
|
187
|
-
sig-check-overridden =
|
|
188
|
-
sig-check-protected =
|
|
186
|
+
sig-check-dunders = true
|
|
187
|
+
sig-check-overridden = true
|
|
188
|
+
sig-check-protected = true
|
|
189
189
|
|
|
190
190
|
..
|
|
191
191
|
end flake8
|
|
@@ -252,7 +252,7 @@ Standalone
|
|
|
252
252
|
|
|
253
253
|
repos:
|
|
254
254
|
- repo: https://github.com/jshwi/docsig
|
|
255
|
-
rev: v0.
|
|
255
|
+
rev: v0.86.0
|
|
256
256
|
hooks:
|
|
257
257
|
- id: docsig
|
|
258
258
|
args:
|
|
@@ -271,7 +271,7 @@ or integrated with ``flake8``
|
|
|
271
271
|
hooks:
|
|
272
272
|
- id: flake8
|
|
273
273
|
additional_dependencies:
|
|
274
|
-
- docsig==0.
|
|
274
|
+
- docsig==0.86.0
|
|
275
275
|
args:
|
|
276
276
|
- "--sig-check-class"
|
|
277
277
|
- "--sig-check-dunders"
|
|
@@ -147,17 +147,10 @@ def build_parser() -> _ArgumentParser:
|
|
|
147
147
|
help="check class docstrings",
|
|
148
148
|
dest="check_class",
|
|
149
149
|
)
|
|
150
|
-
group.add_argument(
|
|
151
|
-
"-C",
|
|
152
|
-
action="store_true",
|
|
153
|
-
help=_argparse.SUPPRESS,
|
|
154
|
-
dest="check_class_constructor",
|
|
155
|
-
)
|
|
156
150
|
group.add_argument(
|
|
157
151
|
"--check-class-constructor",
|
|
158
152
|
action="store_true",
|
|
159
153
|
help="check __init__ methods",
|
|
160
|
-
dest="check_class_constructor",
|
|
161
154
|
)
|
|
162
155
|
parser.add_argument(
|
|
163
156
|
"-D",
|
|
@@ -16,7 +16,6 @@ from ._hooks import excepthook as _excepthook
|
|
|
16
16
|
def _warn_on_deprecated_short_flags() -> None:
|
|
17
17
|
deprecated_short_flags = {
|
|
18
18
|
"-c": "--check-class",
|
|
19
|
-
"-C": "--check-class-constructor",
|
|
20
19
|
"-D": "--check-dunders",
|
|
21
20
|
"-o": "--check-overridden",
|
|
22
21
|
"-p": "--check-protected",
|
|
@@ -61,7 +61,7 @@ class Failure(list[Failed]):
|
|
|
61
61
|
|
|
62
62
|
def __init__(self, func: _Function, config: _Config) -> None:
|
|
63
63
|
super().__init__()
|
|
64
|
-
self._retcode = 0
|
|
64
|
+
self._retcode = [0]
|
|
65
65
|
self._func = func
|
|
66
66
|
if config.target:
|
|
67
67
|
self._func.messages.extend(
|
|
@@ -100,7 +100,7 @@ class Failure(list[Failed]):
|
|
|
100
100
|
hint: bool = False,
|
|
101
101
|
**kwargs: _t.Any,
|
|
102
102
|
) -> None:
|
|
103
|
-
self._retcode
|
|
103
|
+
self._retcode.append(int(not value.new))
|
|
104
104
|
failed = Failed(
|
|
105
105
|
self._name,
|
|
106
106
|
value.ref,
|
|
@@ -321,7 +321,7 @@ class Failure(list[Failed]):
|
|
|
321
321
|
# invalid-syntax
|
|
322
322
|
if self._func.error is _ast.AstroidSyntaxError:
|
|
323
323
|
self._add(_E[901])
|
|
324
|
-
self._retcode
|
|
324
|
+
self._retcode.append(123)
|
|
325
325
|
# unicode-decode-error
|
|
326
326
|
if self._func.error is UnicodeDecodeError:
|
|
327
327
|
self._add(_E[902])
|
|
@@ -345,7 +345,7 @@ class Failure(list[Failed]):
|
|
|
345
345
|
@property
|
|
346
346
|
def retcode(self) -> int:
|
|
347
347
|
"""Exit code (non-zero if any check failed)."""
|
|
348
|
-
return self._retcode
|
|
348
|
+
return max(self._retcode)
|
|
349
349
|
|
|
350
350
|
|
|
351
351
|
def report(
|
|
@@ -11,7 +11,7 @@ line-length = 79
|
|
|
11
11
|
allow_dirty = true
|
|
12
12
|
commit = true
|
|
13
13
|
commit_args = "-sS"
|
|
14
|
-
current_version = "0.
|
|
14
|
+
current_version = "0.86.0"
|
|
15
15
|
message = "bump: version {current_version} → {new_version}"
|
|
16
16
|
sign_tags = true
|
|
17
17
|
tag = true
|
|
@@ -27,11 +27,6 @@ filename = "pyproject.toml"
|
|
|
27
27
|
replace = 'version = "{new_version}"'
|
|
28
28
|
search = 'version = "{current_version}"'
|
|
29
29
|
|
|
30
|
-
[[tool.bumpversion.files]]
|
|
31
|
-
filename = "package.json"
|
|
32
|
-
replace = '"version": "{new_version}"'
|
|
33
|
-
search = '"version": "{current_version}"'
|
|
34
|
-
|
|
35
30
|
[[tool.bumpversion.files]]
|
|
36
31
|
filename = "README.rst"
|
|
37
32
|
replace = "rev: v{new_version}"
|
|
@@ -122,7 +117,7 @@ maintainers = [
|
|
|
122
117
|
name = "docsig"
|
|
123
118
|
readme = "README.rst"
|
|
124
119
|
repository = "https://github.com/jshwi/docsig"
|
|
125
|
-
version = "0.
|
|
120
|
+
version = "0.86.0"
|
|
126
121
|
|
|
127
122
|
[tool.poetry.dependencies]
|
|
128
123
|
Sphinx = ">=7,<9"
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|