Comments (4)
Thanks for the clarification!
I made a code change and now your test case should produce the following error message:
Lines 1090 to 1097 in bef414f
Note that the error message shows [x: int]
rather than [x: ]
-- this is for backward compatibility purposes.
from pydoclint.
The code change is published as v0.3.4 to PyPI.
from pydoclint.
Hi @ezwelty , this is because there needs to be :
in the arg list of the docstring.
Please check out the note in this error message:
DOC103: Function f: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ).
from pydoclint.
@jsh9 Did you maybe misread my issue? The :
is omitted when a type is not given. See the numpy style guide (https://numpydoc.readthedocs.io/en/latest/format.html#parameters). With the following file and --arg-type-hints-in-docstring False
, no errors are returned (as expected).
"""Module docstring."""
def f(x: int, y: int, z: int) -> None:
"""
Run f().
Parameters
----------
x
x
y
y
z
z
"""
pass
from pydoclint.
Related Issues (20)
- Request: not throwing DOC501 for `abstractmethod` HOT 2
- Docs request: `pre-commit` config for `flake8` HOT 1
- Parameters not processed correctly for numpy style with incorrect underscoring HOT 1
- Add shortcuts for long typing.Annotated type hints HOT 3
- BUG: Return literal with double quotes incorrectly raises v203 HOT 3
- Request: Add configuration option that allows for type hint in signature _or_ docstring, but not both HOT 2
- **kwargs only arguments throw DOC106 and DOC109 HOT 2
- Failure to detect the `import typing as tt` convention HOT 2
- Failure to detect `noqa` statement HOT 5
- Google style: Allow omitting only the `Returns`/`Yields` if summary starts with `Return(s)/Yield(s)` HOT 16
- Google style: Allow documenting `@property`s as a member HOT 5
- Allow more control over`--skip-checking-short-docstrings` HOT 4
- Unused function arguments HOT 5
- Option to disable printing config HOT 2
- Sphinx prefers escaping the asterisk for *args and **kwargs with a backslash but this confuses pydoclint HOT 5
- Incorrect sample `pre-commit` config HOT 1
- Docs request: are ignores possible when not in `flake8` mode? HOT 4
- Docs request: easier to find link to https://jsh9.github.io/pydoclint/ in `README.md` HOT 1
- Docs request: more info on `allow-init-docstring` HOT 3
- Request: ability to disable certain codes explicitly via config HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pydoclint.