Comments (2)
Hi @Oreilles , thanks for submitting this issue.
From my perspective, the potential difficulty with this suggestion is: instance attributes are difficult to check.
Here's an example of "class attributes" and "instance attributes", in case there are any confusions:
class Car:
# Class attribute
num_wheels = 4
def __init__(self, make, model):
# Instance attributes
self.make = make
self.model = model
According to the Google style guide, if we are to document public attributes, we should document both class attributes and instance attributes.
The order and type hints of instance attributes are not easy to check (we may not want to enforce order anyways).
from pydoclint.
Came here after realizing that my dataclass attributes were not being checked. Maybe an option that can be set to enforce checking class attributes with caveats shown on screen?
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
- 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
- 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
- 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.