-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
changed paths in kwdocs #11443
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
changed paths in kwdocs #11443
Conversation
ba841c3
to
fd8622c
Compare
I'm having trouble telling where and what the change is supposed to be. Can you give more detail, pref with a link to https://circleci.com/gh/matplotlib/matplotlib/10434/artifacts/0//home/circleci/project/doc/build/html/index.html |
I don't think that it is rendered in the docs at the moment but it probably should be in for example The difference is that Some test code
|
I added some docstrings |
Many links in the kwargs list in don't work. This PR fix those links. |
daf64d9
to
c6c6cf7
Compare
Could someone review this? This pr make the links in the kwarg lists in for example work. |
I've checked against master and did not see any change in the links. Which ones exactly do not work on master? |
The bold parameter list is a regression from #11495. I'll detail what's going on and fix it in a separate PR. You don't have to worry about that here. |
Thanks @fredrik-1 ! (quick note--@timhoffm I don't know if you are aware that for documentation pull request, only one core dev is required to approve the PR before merging) |
@NelleV I think that’s true for bare edits of the docs. This was an actual code change for how the docs are handled. |
Yeah, good point. |
The links to the axes properties where not rendered correctly in the kwdoc table because
axes._base
andaxes._axes
are not included in the documentation. This is a simple solution that change the paths.edit: So the changes is in the rendered docstrings when
docstring.dedent_interpd
is used with%(Axes)s
(and maybe in some other docstrings)