Comments (2)
Got you.
Of course it's from a PR I received and that's the one thing I didn't check.
Ended up finding numpydoc
, and the ability to run
python -m numpydoc pdpipe.run_time_parameters --validate
I'm going to create a numpy-docstring-linting job for my Github Actions, which will prevent this in the future. :)
Thank you!
from griffe.
Hi!
It seems you're using the "type" slot for the description in your docstrings, for example here: pdpipe/pdpipe@b7120ef#diff-ef300b911b47cd25532c53d54944b8153438298de58c57f3629c679341881a18R1207
I'm seeing other errors such as indentation and formatting of the returns section
Our parser tries to follow the Numpydoc style guide.
I'll go ahead and close this for now, don't hesitate to open new issues once your formatting is fixed 🙂
"BoolOp" warnings are already tracked in #93!
from griffe.
Related Issues (20)
- bug: Custom implementation of cached_property results in property being categorized as a "method" instead of a cached property HOT 7
- bug: Google docstrings: no support for non-multiple or non-named values in Yields section HOT 3
- feature: extension(?): relative cross-references in docstrings, but resolved by the handler/extractor HOT 6
- feature: Pre-commit integration HOT 4
- feature: Allow passing multiple args to `Object.has_labels` instead of a set
- feature: Allow passing multiple args to `load_extensions` instead of a list
- bug: bad handling of str module_path in loader.py:_load_module_path HOT 2
- feature: Populate lines collection within helpers
- refactor: Change the logic for the `lines` property of objects
- refactor: Maybe rework the logic for objects `lines` or `source` HOT 1
- bug: setuptools editable install finder with ast.AnnAssign leads to unfound modules HOT 3
- bug: griffe doesn't render dynamic docstrings HOT 2
- bug: Different results when checking API breaking changes with static and dynamic analysis
- refactor: Rewrite diff logic to actually return differences, not just breaking changes
- refactor: Rework public API
- docs: Improve docstrings and docs HOT 1
- refactor: Rework "exported" and "public" logic
- feature: Support conventions to mark objects as public HOT 2
- bug: attempting to load external non-module alias triggers .resolve_target() HOT 2
- feat: Generate `__init__` methods for typed dicts with `**kwargs: Unpack[MyDict]` to help docstring parser fetch other parameters types HOT 7
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 griffe.