Comments (5)
Hi @ddelange , if you try to use from typing import Iterator
, does the issue go away?
from pydoclint.
Yes, when I change the import, the noqa's would be no longer necessary. This issue is about the noqa statement having no effect.
from pydoclint.
I see. Let me look into it in the next few days then. Thanks!
from pydoclint.
No hurries, have a nice weekend!
from pydoclint.
Hi @ddelange : sorry for the late reply!
To make noqa
work, you'd need to use flake8
rather than directly using pydoclint
.
Here is the documentation (link):
2.2. As a flake8 plugin
Once you install pydoclint you will have also installed flake8. Then you can run:flake8 --select=DOC <FILE_OR_FOLDER>
If you don't include --select=DOC in your command, flake8 will also run other built-in flake8 linters on your code.
I verified it with your code example, and I was able to get 0 violations.
from pydoclint.
Related Issues (20)
- 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
- 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
- More config control for type hinting in signature HOT 2
- Option to only check for non-existent params in pydocs, rather than params missing in pydocs HOT 2
- Deprecated command line argument `--src` leads to errors or missing proper documentation HOT 2
- Google style: Allow omitting `*args` and `**kwargs` from doc string HOT 3
- Add class attributes checking support HOT 2
- False positive DOC201 HOT 1
- False positive DOC405 HOT 6
- False positive 403 with "yield from" statement HOT 1
- Check for missing or incorrectly formatted docstring HOT 1
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.