Comments (6)
Hello again! Has this been fixed/implemented?
from pytkdocs.
8 months later...
No 😕
PRs welcome. I'm currently reducing the number of open issues to keep the ones we could still implement/fix in pytkdocs (which will be replaced by a more robust tool).
from pytkdocs.
@pawamoy Hmm, I see your preferred solution but wouldn't it make more sense to have the renderer read the members and act accordingly? Especially since the renderer has since added a new sorting option mkdocstrings/mkdocstrings#274
from pytkdocs.
@ofek sorry for the late reply 🙇
have the renderer read the members and act accordingly
Unfortunately that is not possible, because mkdocstrings passes the selection options only to the collector, not the renderer. I wouldn't be against a refactor that removes the distinction between these two options groups (no more selection/rendering keys, no more base renderer / base collector classes, just a base handler one that receives all options). Up to the discussion of course.
I'll try to come up with a workaround in the next few days (keeping that issue in my saved notifications).
Also note that I've been working on a new "collector" which might alleviate this issue. I'll try to move forward on this in the next few days as well.
from pytkdocs.
This should now be fixed (finally 🥵!), at least with the new Python handler.
from pytkdocs.
Ah, but we're in the pytkdocs repo here 🤦
So it's not fixed. But it can now be fixed. Reopening.
from pytkdocs.
Related Issues (20)
- [BUG] Wrong version from python package HOT 2
- [BUG] Pydantic model fields don't display in documentation HOT 4
- [BUG] Support typing-extensions 4.x HOT 2
- [BUG] Cannot extract docstring from output of `make_dataclass`
- Add support for help_text field parameter as description with django model fields.
- Line numbers in error messages HOT 1
- [BUG] Pytkdocs Loader assumes '_meta' attribute of classes has a 'get_fields' method HOT 5
- [DOCS] Docstrings don't match up with function parameters HOT 1
- [BUG] missing numpydoc parameters validation resulting in Nonetype exception HOT 2
- [BUG] use of `set` as class attribute type causes exception HOT 5
- [BUG] type unions with pipes not supported HOT 2
- [BUG] Wrong docstrings for attribute when aliased from another class HOT 2
- [BUG] detect_field_model fails for DjangoModelFactory from factory-boy HOT 3
- [BUG] Error displaying wrapped Python functions where wrapper is from another module HOT 3
- [BUG] 'builtin_function_or_method' object is not subscriptable HOT 2
- `inherited_members` Does **Not** Work HOT 4
- Decorators which alternate docstrings are ignored HOT 3
- [BUG] pandera model wrongly detected as pydantic and pytkdocs tries to read non existent attributes HOT 7
- pytkdocs/django compatibility issues HOT 5
- Decorator to ignore specific functions during the docstrings "discovery" HOT 4
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 pytkdocs.