Auto-generate required kwdoc entries into docstring.interpd. #20164
Conversation
|
Wow, I learn something new everyday - I had no idea Since we are screwing with this, is it possible to come up with a better name that |
|
Seems fine to me, but I guess that can be a separate PR? It's just a global search-replace anyways... (the old name can be kept for backcompat) |
|
I mean you are changing them all the instances here, is this not a good time to decide what to change them to? |
|
I'm not changing the name of interpd? (perhaps I'm just confused?) |
This does two things: - Replace Foo_kwdoc docstring substitutions by auto-generated Foo:kwdoc substitutions, removing the need to explicitly call `docstring.interpd.update(Foo_kwdoc=artist.kwdoc(Foo))` for each artist. - Decorating a class with `docstring.interpd` will now also perform interpolation over the docstring of the class' `__init__`, making it possible to list properties here as well, instead of having to manually call `docstring.interpd` after the class has been defined. The new behavior is also explained in documenting_mpl.rst. I think it's slightly more magical, but also easier to explain...
This does two things:
Replace Foo_kwdoc docstring substitutions by auto-generated
Foo:kwdoc substitutions, removing the need to explicitly call
docstring.interpd.update(Foo_kwdoc=artist.kwdoc(Foo))for eachartist.
Decorating a class with
docstring.interpdwill now also performinterpolation over the docstring of the class'
__init__, making itpossible to list properties here as well, instead of having to
manually call
docstring.interpdafter the class has been defined.The new behavior is also explained in documenting_mpl.rst. I think it's
slightly more magical, but also easier to explain...
Thoughts?
PR Summary
PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsand runflake8 --docstring-convention=all).doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).