docsig 0.53.0__tar.gz → 0.53.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.53.0 → docsig-0.53.1}/PKG-INFO +4 -3
- {docsig-0.53.0 → docsig-0.53.1}/README.rst +3 -2
- {docsig-0.53.0 → docsig-0.53.1}/docsig/_module.py +6 -1
- {docsig-0.53.0 → docsig-0.53.1}/docsig/_version.py +1 -1
- {docsig-0.53.0 → docsig-0.53.1}/pyproject.toml +1 -1
- {docsig-0.53.0 → docsig-0.53.1}/LICENSE +0 -0
- {docsig-0.53.0 → docsig-0.53.1}/docsig/__init__.py +0 -0
- {docsig-0.53.0 → docsig-0.53.1}/docsig/__main__.py +0 -0
- {docsig-0.53.0 → docsig-0.53.1}/docsig/_config.py +0 -0
- {docsig-0.53.0 → docsig-0.53.1}/docsig/_core.py +0 -0
- {docsig-0.53.0 → docsig-0.53.1}/docsig/_decorators.py +0 -0
- {docsig-0.53.0 → docsig-0.53.1}/docsig/_directives.py +0 -0
- {docsig-0.53.0 → docsig-0.53.1}/docsig/_hooks.py +0 -0
- {docsig-0.53.0 → docsig-0.53.1}/docsig/_main.py +0 -0
- {docsig-0.53.0 → docsig-0.53.1}/docsig/_report.py +0 -0
- {docsig-0.53.0 → docsig-0.53.1}/docsig/_stub.py +0 -0
- {docsig-0.53.0 → docsig-0.53.1}/docsig/_utils.py +0 -0
- {docsig-0.53.0 → docsig-0.53.1}/docsig/messages.py +0 -0
- {docsig-0.53.0 → docsig-0.53.1}/docsig/py.typed +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: docsig
|
|
3
|
-
Version: 0.53.
|
|
3
|
+
Version: 0.53.1
|
|
4
4
|
Summary: Check signature params for proper documentation
|
|
5
5
|
Home-page: https://pypi.org/project/docsig/
|
|
6
6
|
License: MIT
|
|
@@ -129,7 +129,8 @@ Commandline
|
|
|
129
129
|
-o, --check-overridden check overridden methods
|
|
130
130
|
-p, --check-protected check protected functions and classes
|
|
131
131
|
-P, --check-property-returns check property return values
|
|
132
|
-
-i, --ignore-no-params ignore docstrings where parameters are not
|
|
132
|
+
-i, --ignore-no-params ignore docstrings where parameters are not
|
|
133
|
+
documented
|
|
133
134
|
-a, --ignore-args ignore args prefixed with an asterisk
|
|
134
135
|
-k, --ignore-kwargs ignore kwargs prefixed with two asterisks
|
|
135
136
|
-T, --ignore-typechecker ignore checking return values
|
|
@@ -221,7 +222,7 @@ It can be added to your .pre-commit-config.yaml as follows:
|
|
|
221
222
|
|
|
222
223
|
repos:
|
|
223
224
|
- repo: https://github.com/jshwi/docsig
|
|
224
|
-
rev: v0.53.
|
|
225
|
+
rev: v0.53.1
|
|
225
226
|
hooks:
|
|
226
227
|
- id: docsig
|
|
227
228
|
args:
|
|
@@ -101,7 +101,8 @@ Commandline
|
|
|
101
101
|
-o, --check-overridden check overridden methods
|
|
102
102
|
-p, --check-protected check protected functions and classes
|
|
103
103
|
-P, --check-property-returns check property return values
|
|
104
|
-
-i, --ignore-no-params ignore docstrings where parameters are not
|
|
104
|
+
-i, --ignore-no-params ignore docstrings where parameters are not
|
|
105
|
+
documented
|
|
105
106
|
-a, --ignore-args ignore args prefixed with an asterisk
|
|
106
107
|
-k, --ignore-kwargs ignore kwargs prefixed with two asterisks
|
|
107
108
|
-T, --ignore-typechecker ignore checking return values
|
|
@@ -193,7 +194,7 @@ It can be added to your .pre-commit-config.yaml as follows:
|
|
|
193
194
|
|
|
194
195
|
repos:
|
|
195
196
|
- repo: https://github.com/jshwi/docsig
|
|
196
|
-
rev: v0.53.
|
|
197
|
+
rev: v0.53.1
|
|
197
198
|
hooks:
|
|
198
199
|
- id: docsig
|
|
199
200
|
args:
|
|
@@ -152,7 +152,12 @@ class Parent(_t.List["Parent"]):
|
|
|
152
152
|
self._imports,
|
|
153
153
|
)
|
|
154
154
|
if func.isoverloaded:
|
|
155
|
-
|
|
155
|
+
if (
|
|
156
|
+
func.name not in self._overloads
|
|
157
|
+
or self._overloads[func.name].signature.rettype
|
|
158
|
+
== _RetType.NONE
|
|
159
|
+
):
|
|
160
|
+
self._overloads[func.name] = func
|
|
156
161
|
else:
|
|
157
162
|
if func.name in self._overloads:
|
|
158
163
|
func.overload(
|
|
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
|