docsig 0.88.0__tar.gz → 0.90.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.88.0 → docsig-0.90.0}/PKG-INFO +6 -6
- {docsig-0.88.0 → docsig-0.90.0}/README.rst +4 -4
- {docsig-0.88.0 → docsig-0.90.0}/docsig/_config.py +0 -14
- {docsig-0.88.0 → docsig-0.90.0}/docsig/_main.py +0 -2
- {docsig-0.88.0 → docsig-0.90.0}/docsig/_version.py +1 -1
- {docsig-0.88.0 → docsig-0.90.0}/pyproject.toml +7 -6
- {docsig-0.88.0 → docsig-0.90.0}/LICENSE +0 -0
- {docsig-0.88.0 → docsig-0.90.0}/LICENSES/SPHINX_LICENSE +0 -0
- {docsig-0.88.0 → docsig-0.90.0}/docsig/__init__.py +0 -0
- {docsig-0.88.0 → docsig-0.90.0}/docsig/__main__.py +0 -0
- {docsig-0.88.0 → docsig-0.90.0}/docsig/_check.py +0 -0
- {docsig-0.88.0 → docsig-0.90.0}/docsig/_core.py +0 -0
- {docsig-0.88.0 → docsig-0.90.0}/docsig/_decorators.py +0 -0
- {docsig-0.88.0 → docsig-0.90.0}/docsig/_directives.py +0 -0
- {docsig-0.88.0 → docsig-0.90.0}/docsig/_files.py +0 -0
- {docsig-0.88.0 → docsig-0.90.0}/docsig/_hooks.py +0 -0
- {docsig-0.88.0 → docsig-0.90.0}/docsig/_module.py +0 -0
- {docsig-0.88.0 → docsig-0.90.0}/docsig/_parsers.py +0 -0
- {docsig-0.88.0 → docsig-0.90.0}/docsig/_report.py +0 -0
- {docsig-0.88.0 → docsig-0.90.0}/docsig/_stub.py +0 -0
- {docsig-0.88.0 → docsig-0.90.0}/docsig/_utils.py +0 -0
- {docsig-0.88.0 → docsig-0.90.0}/docsig/_vendor/sphinx/ext/napoleon.py +0 -0
- {docsig-0.88.0 → docsig-0.90.0}/docsig/messages.py +0 -0
- {docsig-0.88.0 → docsig-0.90.0}/docsig/plugin/__init__.py +0 -0
- {docsig-0.88.0 → docsig-0.90.0}/docsig/plugin/_flake8.py +0 -0
- {docsig-0.88.0 → docsig-0.90.0}/docsig/plugin/_validate_pyproject.py +0 -0
- {docsig-0.88.0 → docsig-0.90.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.90.0
|
|
4
4
|
Summary: Check signature params for proper documentation
|
|
5
5
|
License-Expression: MIT
|
|
6
6
|
License-File: LICENSE
|
|
@@ -20,7 +20,7 @@ Classifier: Programming Language :: Python :: 3.14
|
|
|
20
20
|
Requires-Dist: astroid (>=4.0.2,<5.0.0)
|
|
21
21
|
Requires-Dist: pathspec (>=0.12.1,<1.2.0)
|
|
22
22
|
Requires-Dist: tomli (>=2.0.1,<3.0.0)
|
|
23
|
-
Requires-Dist: wcmatch (>=
|
|
23
|
+
Requires-Dist: wcmatch (>=10.2.1,<11.0.0)
|
|
24
24
|
Project-URL: Documentation, https://docsig.io/en/latest
|
|
25
25
|
Project-URL: Homepage, https://docsig.io
|
|
26
26
|
Project-URL: Repository, https://github.com/jshwi/docsig
|
|
@@ -82,7 +82,7 @@ Description-Content-Type: text/x-rst
|
|
|
82
82
|
.. |VS Code Build| image:: https://github.com/jshwi/docsig/actions/workflows/build-vscode-extension.yaml/badge.svg
|
|
83
83
|
:target: https://github.com/jshwi/docsig/actions/workflows/build-vscode-extension.yaml.yaml
|
|
84
84
|
:alt: Build
|
|
85
|
-
.. |VS Code Extension| image:: https://img.shields.io/badge/vscode%20extension-v1.0.
|
|
85
|
+
.. |VS Code Extension| image:: https://img.shields.io/badge/vscode%20extension-v1.0.1-007ACC
|
|
86
86
|
:target: https://marketplace.visualstudio.com/items?itemName=jshwi.docsig
|
|
87
87
|
:alt: VS Code Extension Version
|
|
88
88
|
|
|
@@ -206,7 +206,7 @@ ensure your installation has registered `docsig`
|
|
|
206
206
|
.. code-block:: console
|
|
207
207
|
|
|
208
208
|
$ flake8 --version
|
|
209
|
-
7.3.0 (docsig: 0.
|
|
209
|
+
7.3.0 (docsig: 0.90.0, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.10.19 on Darwin
|
|
210
210
|
|
|
211
211
|
And now use `flake8` to lint your files
|
|
212
212
|
|
|
@@ -292,7 +292,7 @@ Standalone
|
|
|
292
292
|
|
|
293
293
|
repos:
|
|
294
294
|
- repo: https://github.com/jshwi/docsig
|
|
295
|
-
rev: v0.
|
|
295
|
+
rev: v0.90.0
|
|
296
296
|
hooks:
|
|
297
297
|
- id: docsig
|
|
298
298
|
args:
|
|
@@ -311,7 +311,7 @@ or integrated with ``flake8``
|
|
|
311
311
|
hooks:
|
|
312
312
|
- id: flake8
|
|
313
313
|
additional_dependencies:
|
|
314
|
-
- docsig==0.
|
|
314
|
+
- docsig==0.90.0
|
|
315
315
|
args:
|
|
316
316
|
- "--sig-check-class"
|
|
317
317
|
- "--sig-check-dunders"
|
|
@@ -54,7 +54,7 @@
|
|
|
54
54
|
.. |VS Code Build| image:: https://github.com/jshwi/docsig/actions/workflows/build-vscode-extension.yaml/badge.svg
|
|
55
55
|
:target: https://github.com/jshwi/docsig/actions/workflows/build-vscode-extension.yaml.yaml
|
|
56
56
|
:alt: Build
|
|
57
|
-
.. |VS Code Extension| image:: https://img.shields.io/badge/vscode%20extension-v1.0.
|
|
57
|
+
.. |VS Code Extension| image:: https://img.shields.io/badge/vscode%20extension-v1.0.1-007ACC
|
|
58
58
|
:target: https://marketplace.visualstudio.com/items?itemName=jshwi.docsig
|
|
59
59
|
:alt: VS Code Extension Version
|
|
60
60
|
|
|
@@ -178,7 +178,7 @@ ensure your installation has registered `docsig`
|
|
|
178
178
|
.. code-block:: console
|
|
179
179
|
|
|
180
180
|
$ flake8 --version
|
|
181
|
-
7.3.0 (docsig: 0.
|
|
181
|
+
7.3.0 (docsig: 0.90.0, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.10.19 on Darwin
|
|
182
182
|
|
|
183
183
|
And now use `flake8` to lint your files
|
|
184
184
|
|
|
@@ -264,7 +264,7 @@ Standalone
|
|
|
264
264
|
|
|
265
265
|
repos:
|
|
266
266
|
- repo: https://github.com/jshwi/docsig
|
|
267
|
-
rev: v0.
|
|
267
|
+
rev: v0.90.0
|
|
268
268
|
hooks:
|
|
269
269
|
- id: docsig
|
|
270
270
|
args:
|
|
@@ -283,7 +283,7 @@ or integrated with ``flake8``
|
|
|
283
283
|
hooks:
|
|
284
284
|
- id: flake8
|
|
285
285
|
additional_dependencies:
|
|
286
|
-
- docsig==0.
|
|
286
|
+
- docsig==0.90.0
|
|
287
287
|
args:
|
|
288
288
|
- "--sig-check-class"
|
|
289
289
|
- "--sig-check-dunders"
|
|
@@ -168,29 +168,15 @@ def build_parser() -> _ArgumentParser:
|
|
|
168
168
|
help="check overridden methods",
|
|
169
169
|
dest="check_overridden",
|
|
170
170
|
)
|
|
171
|
-
parser.add_argument(
|
|
172
|
-
"-P",
|
|
173
|
-
action="store_true",
|
|
174
|
-
help=_argparse.SUPPRESS,
|
|
175
|
-
dest="check_property_returns",
|
|
176
|
-
)
|
|
177
171
|
parser.add_argument(
|
|
178
172
|
"--check-property-returns",
|
|
179
173
|
action="store_true",
|
|
180
174
|
help="check property return values",
|
|
181
|
-
dest="check_property_returns",
|
|
182
|
-
)
|
|
183
|
-
parser.add_argument(
|
|
184
|
-
"-p",
|
|
185
|
-
action="store_true",
|
|
186
|
-
help=_argparse.SUPPRESS,
|
|
187
|
-
dest="check_protected",
|
|
188
175
|
)
|
|
189
176
|
parser.add_argument(
|
|
190
177
|
"--check-protected",
|
|
191
178
|
action="store_true",
|
|
192
179
|
help="check protected functions and classes",
|
|
193
|
-
dest="check_protected",
|
|
194
180
|
)
|
|
195
181
|
parser.add_argument(
|
|
196
182
|
"--check-protected-class-methods",
|
|
@@ -12,7 +12,7 @@ dependencies = [
|
|
|
12
12
|
"astroid (>=4.0.2,<5.0.0)",
|
|
13
13
|
"pathspec (>=0.12.1,<1.2.0)",
|
|
14
14
|
"tomli (>=2.0.1,<3.0.0)",
|
|
15
|
-
"wcmatch (>=
|
|
15
|
+
"wcmatch (>=10.2.1,<11.0.0)"
|
|
16
16
|
]
|
|
17
17
|
description = "Check signature params for proper documentation"
|
|
18
18
|
keywords = [
|
|
@@ -29,7 +29,7 @@ maintainers = [
|
|
|
29
29
|
name = "docsig"
|
|
30
30
|
readme = "README.rst"
|
|
31
31
|
requires-python = ">=3.10"
|
|
32
|
-
version = "0.
|
|
32
|
+
version = "0.90.0"
|
|
33
33
|
|
|
34
34
|
[project.entry-points."flake8.extension"]
|
|
35
35
|
SIG = "docsig.plugin:Flake8"
|
|
@@ -47,7 +47,7 @@ line-length = 79
|
|
|
47
47
|
allow_dirty = true
|
|
48
48
|
commit = true
|
|
49
49
|
commit_args = "-sS"
|
|
50
|
-
current_version = "0.
|
|
50
|
+
current_version = "0.90.0"
|
|
51
51
|
message = "bump: version {current_version} → {new_version}"
|
|
52
52
|
sign_tags = true
|
|
53
53
|
tag = true
|
|
@@ -102,6 +102,7 @@ omit = [
|
|
|
102
102
|
|
|
103
103
|
[tool.deptry.per_rule_ignores]
|
|
104
104
|
DEP004 = [
|
|
105
|
+
"docutils",
|
|
105
106
|
"flake8",
|
|
106
107
|
"git",
|
|
107
108
|
"pytest",
|
|
@@ -147,25 +148,25 @@ deptry = ">=0.16.1,<0.26.0"
|
|
|
147
148
|
flynt = "^1.0.1"
|
|
148
149
|
gitpython = "^3.1.43"
|
|
149
150
|
isort = ">=5.13.2,<9.0.0"
|
|
150
|
-
mypy = ">=
|
|
151
|
+
mypy = ">=2.2.0,<3.0"
|
|
151
152
|
pre-commit = ">=3.3.3,<5.0.0"
|
|
152
153
|
pylint = "^4.0.6"
|
|
153
154
|
tomli = "^2.0.1"
|
|
154
155
|
tomli-w = "^1.0.0"
|
|
155
156
|
towncrier = ">=23.11,<26.0"
|
|
156
|
-
tox = "^4.
|
|
157
|
+
tox = "^4.56.4"
|
|
157
158
|
validate-pyproject = {extras = ["all", "store"], version = "^0.25"}
|
|
158
159
|
vulture = "^2.11"
|
|
159
160
|
|
|
160
161
|
[tool.poetry.group.docs.dependencies]
|
|
161
162
|
Sphinx = ">=7,<8.2"
|
|
163
|
+
docutils = ">=0.18,<0.22"
|
|
162
164
|
furo = ">=2024.4.27,<2026.0.0"
|
|
163
165
|
myst-parser = ">=3.0.1,<5.0.0"
|
|
164
166
|
pytest = "9.1.1"
|
|
165
167
|
pyyaml = "^6.0.1"
|
|
166
168
|
roman-numerals = "4.1.0"
|
|
167
169
|
sphinx-copybutton = "^0.5.2"
|
|
168
|
-
sphinx-jsonschema = "^1.19.2"
|
|
169
170
|
sphinx-markdown-builder = ">=0.5.5,<0.7.0"
|
|
170
171
|
sphinx-sitemap = "^2.9.0"
|
|
171
172
|
|
|
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
|
|
File without changes
|
|
File without changes
|
|
File without changes
|