You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The default value (["!^_[^_]"]) means: render every object, except those starting with one underscore, unless they start with two underscores. It means that an object whose name is hello, __hello, or hello will be rendered, but not one whose name is _hello.
This is the case with mkdocstrings 0.27.0, where single underscored methods are not included, but starting in 0.28.0 (and the latest 0.28.2), they are included.
To Reproduce
git clone https://github.com/python-humanize/humanize
cd humanize
edit docs/requirements.txt # change to mkdocstrings[python]==0.27.0 or mkdocstrings[python]==0.28.0
rm -rf site; tox -r -e docs && open site/time/index.html
Thanks for the report @hugovk, I was able to confirm. I forgot to apply the default filters as a default value to the relevant field in one of the dataclasses. Will be fixed in next release 🙂
Description of the bug
https://mkdocstrings.github.io/python/usage/configuration/members/#filters says:
This is the case with mkdocstrings 0.27.0, where single underscored methods are not included, but starting in 0.28.0 (and the latest 0.28.2), they are included.
To Reproduce
With 0.28.0:
Expected behavior
With 0.27.0:
Environment information
python -m mkdocstrings_handlers.python.debug # | xclip -selection clipboard
mkdocs
v1.6.1mkdocstrings
v0.28.0mkdocstrings-python
v1.16.1griffe
v1.6.0The text was updated successfully, but these errors were encountered: