Comments (1)
pawamoy
commented on June 14, 2024
Personally I find this intuitive: if you don't pass any extra keyword argument, then the kwarg variable is an empty dict (and the args variable in an empty tuple), and you can use them as such.
But seeing how others get sometimes confused by this, we could probably not show anything in the "default" column indeed. The issue is, it bothers me to change that in Griffe itself, as this is technically correct in terms of API signature I think. Maybe we could override that in the Python handler of mkdocstrings instead.
from griffe.
Related Issues (20)
- feature: link to re-export instead of inserting full documentation HOT 4
- bug: when using `import x.y.z as a`, Griffe thinks `a` is an alias for `x`, not `x.y.z` HOT 4
- bug: parsing of annotations placed after parameters section fails HOT 1
- docs: Add an example CI setup HOT 1
- 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
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.