Comments (2)
rht
commented on July 28, 2024
That's a good idea. I remembered searching about this in the past, but couldn't find my past note. Anyway, searching fresh again resulted in https://github.com/jsh9/pydoclint (much faster than darglint).
pydoclint currently has 7 categories of style violation codes:
DOC0xx: Docstring parsing issues
DOC1xx: Violations about input arguments
DOC2xx: Violations about return argument(s)
DOC3xx: Violations about class docstring and class constructor
DOC4xx: Violations about “yield” statements
DOC5xx: Violations about “raise” statements
DOC6xx: Violations about class attributes
from mesa-frames.
adamamer20
commented on July 28, 2024
Yes that's exactly what I wanted. Very good, they also have a pre-commit hook:
rev: <latest_tag>
hooks:
- id: pydoclint
args: [--style=google, --check-return-types=False]
from mesa-frames.
Related Issues (20)
- Refactoring mesa-examples HOT 1
- Refactoring Discrete Event scheduler
- GPU integration: Dask, cuda (cudf) and RAPIDS (Polars) HOT 11
- Towards parity with Mesa's core repo practices
- Migrate Tests from Private APIs to Public APIs
- Test-Driven Development Using `hypothesis` and `deal` HOT 1
- Run-time type checking
- Benchmark result of docs/scripts/readme_plot.py, native expression vs concise/simple API HOT 3
- The benchmark in the ReadMe seems to execute a too slow pure-python version HOT 5
- Use the -O flag for improved performance in error handling
- Implement indexable properties for Collection attributes using the descriptor protocol
- Concrete GridPandas
- Concrete GridPolars
- Concrete ContinousSpaceDF
- Concrete MultiSpaceDF
- Concrete GeoGridDF
- Abstract SpaceDF
- Abstract DiscreteSpaceDF
- Abstract GridDF
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 mesa-frames.