docsig 0.60.0__tar.gz → 0.60.1__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.60.0 → docsig-0.60.1}/PKG-INFO +5 -5
- {docsig-0.60.0 → docsig-0.60.1}/README.rst +3 -3
- {docsig-0.60.0 → docsig-0.60.1}/docsig/_stub.py +8 -5
- {docsig-0.60.0 → docsig-0.60.1}/docsig/_version.py +1 -1
- {docsig-0.60.0 → docsig-0.60.1}/pyproject.toml +4 -4
- {docsig-0.60.0 → docsig-0.60.1}/LICENSE +0 -0
- {docsig-0.60.0 → docsig-0.60.1}/docsig/__init__.py +0 -0
- {docsig-0.60.0 → docsig-0.60.1}/docsig/__main__.py +0 -0
- {docsig-0.60.0 → docsig-0.60.1}/docsig/_config.py +0 -0
- {docsig-0.60.0 → docsig-0.60.1}/docsig/_core.py +0 -0
- {docsig-0.60.0 → docsig-0.60.1}/docsig/_decorators.py +0 -0
- {docsig-0.60.0 → docsig-0.60.1}/docsig/_directives.py +0 -0
- {docsig-0.60.0 → docsig-0.60.1}/docsig/_files.py +0 -0
- {docsig-0.60.0 → docsig-0.60.1}/docsig/_hooks.py +0 -0
- {docsig-0.60.0 → docsig-0.60.1}/docsig/_main.py +0 -0
- {docsig-0.60.0 → docsig-0.60.1}/docsig/_module.py +0 -0
- {docsig-0.60.0 → docsig-0.60.1}/docsig/_report.py +0 -0
- {docsig-0.60.0 → docsig-0.60.1}/docsig/_utils.py +0 -0
- {docsig-0.60.0 → docsig-0.60.1}/docsig/messages.py +0 -0
- {docsig-0.60.0 → docsig-0.60.1}/docsig/plugin.py +0 -0
- {docsig-0.60.0 → docsig-0.60.1}/docsig/py.typed +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: docsig
|
|
3
|
-
Version: 0.60.
|
|
3
|
+
Version: 0.60.1
|
|
4
4
|
Summary: Check signature params for proper documentation
|
|
5
5
|
Home-page: https://pypi.org/project/docsig/
|
|
6
6
|
License: MIT
|
|
@@ -20,7 +20,7 @@ Requires-Dist: Sphinx (>=7.0.0,<8.0.0)
|
|
|
20
20
|
Requires-Dist: arcon (>=0.4.0)
|
|
21
21
|
Requires-Dist: astroid (>=3.0.1,<4.0.0)
|
|
22
22
|
Requires-Dist: pathspec (>=0.12.1,<0.13.0)
|
|
23
|
-
Requires-Dist: wcmatch (>=8.5.2,<
|
|
23
|
+
Requires-Dist: wcmatch (>=8.5.2,<10.0.0)
|
|
24
24
|
Project-URL: Documentation, https://docsig.readthedocs.io/en/latest
|
|
25
25
|
Project-URL: Repository, https://github.com/jshwi/docsig
|
|
26
26
|
Description-Content-Type: text/x-rst
|
|
@@ -172,7 +172,7 @@ ensure your installation has registered `docsig`
|
|
|
172
172
|
.. code-block:: console
|
|
173
173
|
|
|
174
174
|
$ flake8 --version
|
|
175
|
-
7.1.0 (docsig: 0.60.
|
|
175
|
+
7.1.0 (docsig: 0.60.1, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
|
|
176
176
|
|
|
177
177
|
And now use `flake8` to lint your files
|
|
178
178
|
|
|
@@ -261,7 +261,7 @@ Standalone
|
|
|
261
261
|
|
|
262
262
|
repos:
|
|
263
263
|
- repo: https://github.com/jshwi/docsig
|
|
264
|
-
rev: v0.60.
|
|
264
|
+
rev: v0.60.1
|
|
265
265
|
hooks:
|
|
266
266
|
- id: docsig
|
|
267
267
|
args:
|
|
@@ -280,7 +280,7 @@ or integrated with ``flake8``
|
|
|
280
280
|
hooks:
|
|
281
281
|
- id: flake8
|
|
282
282
|
additional_dependencies:
|
|
283
|
-
- docsig==0.60.
|
|
283
|
+
- docsig==0.60.1
|
|
284
284
|
args:
|
|
285
285
|
- "--sig-check-class"
|
|
286
286
|
- "--sig-check-dunders"
|
|
@@ -145,7 +145,7 @@ ensure your installation has registered `docsig`
|
|
|
145
145
|
.. code-block:: console
|
|
146
146
|
|
|
147
147
|
$ flake8 --version
|
|
148
|
-
7.1.0 (docsig: 0.60.
|
|
148
|
+
7.1.0 (docsig: 0.60.1, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
|
|
149
149
|
|
|
150
150
|
And now use `flake8` to lint your files
|
|
151
151
|
|
|
@@ -234,7 +234,7 @@ Standalone
|
|
|
234
234
|
|
|
235
235
|
repos:
|
|
236
236
|
- repo: https://github.com/jshwi/docsig
|
|
237
|
-
rev: v0.60.
|
|
237
|
+
rev: v0.60.1
|
|
238
238
|
hooks:
|
|
239
239
|
- id: docsig
|
|
240
240
|
args:
|
|
@@ -253,7 +253,7 @@ or integrated with ``flake8``
|
|
|
253
253
|
hooks:
|
|
254
254
|
- id: flake8
|
|
255
255
|
additional_dependencies:
|
|
256
|
-
- docsig==0.60.
|
|
256
|
+
- docsig==0.60.1
|
|
257
257
|
args:
|
|
258
258
|
- "--sig-check-class"
|
|
259
259
|
- "--sig-check-dunders"
|
|
@@ -298,11 +298,14 @@ class Docstring(_Stub):
|
|
|
298
298
|
def _indent_anomaly(string: str) -> bool:
|
|
299
299
|
leading_spaces = []
|
|
300
300
|
for line in string.splitlines():
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
301
|
+
# only check params
|
|
302
|
+
# description or anything else is out of scope
|
|
303
|
+
if line.lstrip().startswith(":"):
|
|
304
|
+
match = _re.match(r"^\s*", line)
|
|
305
|
+
if match is not None:
|
|
306
|
+
spaces = len(match.group())
|
|
307
|
+
if spaces > 0:
|
|
308
|
+
leading_spaces.append(spaces)
|
|
306
309
|
|
|
307
310
|
# look for spaces in odd intervals
|
|
308
311
|
return bool(any(i % 2 != 0 for i in leading_spaces))
|
|
@@ -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.60.
|
|
14
|
+
current_version = "0.60.1"
|
|
15
15
|
message = "bump: version {current_version} → {new_version}"
|
|
16
16
|
sign_tags = true
|
|
17
17
|
tag = true
|
|
@@ -132,7 +132,7 @@ maintainers = [
|
|
|
132
132
|
name = "docsig"
|
|
133
133
|
readme = "README.rst"
|
|
134
134
|
repository = "https://github.com/jshwi/docsig"
|
|
135
|
-
version = "0.60.
|
|
135
|
+
version = "0.60.1"
|
|
136
136
|
|
|
137
137
|
[tool.poetry.dependencies]
|
|
138
138
|
Sphinx = "^7.0.0"
|
|
@@ -140,12 +140,12 @@ arcon = ">=0.4.0"
|
|
|
140
140
|
astroid = "^3.0.1"
|
|
141
141
|
pathspec = "^0.12.1"
|
|
142
142
|
python = "^3.8.1"
|
|
143
|
-
wcmatch = "
|
|
143
|
+
wcmatch = ">=8.5.2,<10.0.0"
|
|
144
144
|
|
|
145
145
|
[tool.poetry.group.dev.dependencies]
|
|
146
146
|
black = "^24.4.2"
|
|
147
147
|
bump-my-version = "^0.24.1"
|
|
148
|
-
deptry = ">=0.16.1,<0.
|
|
148
|
+
deptry = ">=0.16.1,<0.21.0"
|
|
149
149
|
docformatter = "^1.7.5"
|
|
150
150
|
flynt = "^1.0.1"
|
|
151
151
|
gitpython = "^3.1.43"
|
|
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
|