docsig 0.83.0__tar.gz → 0.84.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.83.0 → docsig-0.84.0}/PKG-INFO +5 -5
- {docsig-0.83.0 → docsig-0.84.0}/README.rst +3 -3
- {docsig-0.83.0 → docsig-0.84.0}/docsig/_config.py +0 -7
- {docsig-0.83.0 → docsig-0.84.0}/docsig/_main.py +0 -1
- {docsig-0.83.0 → docsig-0.84.0}/docsig/_version.py +1 -1
- {docsig-0.83.0 → docsig-0.84.0}/pyproject.toml +4 -4
- {docsig-0.83.0 → docsig-0.84.0}/LICENSE +0 -0
- {docsig-0.83.0 → docsig-0.84.0}/docsig/__init__.py +0 -0
- {docsig-0.83.0 → docsig-0.84.0}/docsig/__main__.py +0 -0
- {docsig-0.83.0 → docsig-0.84.0}/docsig/_check.py +0 -0
- {docsig-0.83.0 → docsig-0.84.0}/docsig/_core.py +0 -0
- {docsig-0.83.0 → docsig-0.84.0}/docsig/_decorators.py +0 -0
- {docsig-0.83.0 → docsig-0.84.0}/docsig/_directives.py +0 -0
- {docsig-0.83.0 → docsig-0.84.0}/docsig/_files.py +0 -0
- {docsig-0.83.0 → docsig-0.84.0}/docsig/_hooks.py +0 -0
- {docsig-0.83.0 → docsig-0.84.0}/docsig/_module.py +0 -0
- {docsig-0.83.0 → docsig-0.84.0}/docsig/_parsers.py +0 -0
- {docsig-0.83.0 → docsig-0.84.0}/docsig/_report.py +0 -0
- {docsig-0.83.0 → docsig-0.84.0}/docsig/_stub.py +0 -0
- {docsig-0.83.0 → docsig-0.84.0}/docsig/_utils.py +0 -0
- {docsig-0.83.0 → docsig-0.84.0}/docsig/messages.py +0 -0
- {docsig-0.83.0 → docsig-0.84.0}/docsig/plugin/__init__.py +0 -0
- {docsig-0.83.0 → docsig-0.84.0}/docsig/plugin/_flake8.py +0 -0
- {docsig-0.83.0 → docsig-0.84.0}/docsig/plugin/_validate_pyproject.py +0 -0
- {docsig-0.83.0 → docsig-0.84.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.84.0
|
|
4
4
|
Summary: Check signature params for proper documentation
|
|
5
5
|
License: MIT
|
|
6
6
|
License-File: LICENSE
|
|
@@ -19,7 +19,7 @@ Classifier: Programming Language :: Python :: 3.13
|
|
|
19
19
|
Classifier: Programming Language :: Python :: 3.14
|
|
20
20
|
Requires-Dist: Sphinx (>=7,<9)
|
|
21
21
|
Requires-Dist: astroid (>=4.0.2,<5.0.0)
|
|
22
|
-
Requires-Dist: pathspec (>=0.12.1,<1.
|
|
22
|
+
Requires-Dist: pathspec (>=0.12.1,<1.2.0)
|
|
23
23
|
Requires-Dist: tomli (>=2.0.1,<3.0.0)
|
|
24
24
|
Requires-Dist: wcmatch (>=8.5.2,<11.0.0)
|
|
25
25
|
Project-URL: Documentation, https://docsig.io/en/latest
|
|
@@ -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.84.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
|
|
|
@@ -281,7 +281,7 @@ Standalone
|
|
|
281
281
|
|
|
282
282
|
repos:
|
|
283
283
|
- repo: https://github.com/jshwi/docsig
|
|
284
|
-
rev: v0.
|
|
284
|
+
rev: v0.84.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.84.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.84.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
|
|
|
@@ -252,7 +252,7 @@ Standalone
|
|
|
252
252
|
|
|
253
253
|
repos:
|
|
254
254
|
- repo: https://github.com/jshwi/docsig
|
|
255
|
-
rev: v0.
|
|
255
|
+
rev: v0.84.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.84.0
|
|
275
275
|
args:
|
|
276
276
|
- "--sig-check-class"
|
|
277
277
|
- "--sig-check-dunders"
|
|
@@ -173,17 +173,10 @@ def build_parser() -> _ArgumentParser:
|
|
|
173
173
|
help="check dunder methods",
|
|
174
174
|
dest="check_dunders",
|
|
175
175
|
)
|
|
176
|
-
parser.add_argument(
|
|
177
|
-
"-N",
|
|
178
|
-
action="store_true",
|
|
179
|
-
help=_argparse.SUPPRESS,
|
|
180
|
-
dest="check_nested",
|
|
181
|
-
)
|
|
182
176
|
parser.add_argument(
|
|
183
177
|
"--check-nested",
|
|
184
178
|
action="store_true",
|
|
185
179
|
help="check nested functions and classes",
|
|
186
|
-
dest="check_nested",
|
|
187
180
|
)
|
|
188
181
|
parser.add_argument(
|
|
189
182
|
"-o",
|
|
@@ -21,7 +21,6 @@ def _warn_on_deprecated_short_flags() -> None:
|
|
|
21
21
|
"-C": "--check-class-constructor",
|
|
22
22
|
"-D": "--check-dunders",
|
|
23
23
|
"-m": "--check-protected-class-methods",
|
|
24
|
-
"-N": "--check-nested",
|
|
25
24
|
"-o": "--check-overridden",
|
|
26
25
|
"-p": "--check-protected",
|
|
27
26
|
"-P": "--check-property-returns",
|
|
@@ -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.84.0"
|
|
15
15
|
message = "bump: version {current_version} → {new_version}"
|
|
16
16
|
sign_tags = true
|
|
17
17
|
tag = true
|
|
@@ -122,12 +122,12 @@ maintainers = [
|
|
|
122
122
|
name = "docsig"
|
|
123
123
|
readme = "README.rst"
|
|
124
124
|
repository = "https://github.com/jshwi/docsig"
|
|
125
|
-
version = "0.
|
|
125
|
+
version = "0.84.0"
|
|
126
126
|
|
|
127
127
|
[tool.poetry.dependencies]
|
|
128
128
|
Sphinx = ">=7,<9"
|
|
129
129
|
astroid = "^4.0.2"
|
|
130
|
-
pathspec = ">=0.12.1,<1.
|
|
130
|
+
pathspec = ">=0.12.1,<1.2.0"
|
|
131
131
|
python = "^3.10"
|
|
132
132
|
tomli = "^2.0.1"
|
|
133
133
|
wcmatch = ">=8.5.2,<11.0.0"
|
|
@@ -169,7 +169,7 @@ pytest = ">=8.2,<10.0"
|
|
|
169
169
|
pytest-benchmark = ">=4,<6"
|
|
170
170
|
pytest-cov = ">=5,<8"
|
|
171
171
|
pytest-gitignore = "^1.3"
|
|
172
|
-
pytest-randomly = "
|
|
172
|
+
pytest-randomly = ">=3.15,<5.0"
|
|
173
173
|
pytest-sugar = "^1.0.0"
|
|
174
174
|
pytest-xdist = "^3.6.1"
|
|
175
175
|
templatest = ">=0.10.1,<0.13.0"
|
|
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
|