Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
NelleV merged 1 commit intomatplotlib:masterfromfredrik-1:kwdoc_bug
Jul 13, 2018
Merged

Conversation

fredrik-1
Copy link
Contributor

@fredrik-1fredrik-1 commentedJun 15, 2018
edited
Loading

The links to the axes properties where not rendered correctly in the kwdoc table becauseaxes._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 whendocstring.dedent_interpd is used with%(Axes)s (and maybe in some other docstrings)

  • Has Pytest style unit tests
  • Code is PEP 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@fredrik-1fredrik-1force-pushed thekwdoc_bug branch 2 times, most recently fromba841c3 tofd8622cCompareJune 15, 2018 20:57
@jklymak
Copy link
Member

I'm having trouble telling where and what the change is supposed to be. Can you give more detail, pref with a link tohttps://circleci.com/gh/matplotlib/matplotlib/10434/artifacts/0//home/circleci/project/doc/build/html/index.html

@fredrik-1
Copy link
ContributorAuthor

fredrik-1 commentedJun 16, 2018
edited
Loading

I don't think that it is rendered in the docs at the moment but it probably should be in for exampleaxes._base._AxesBase.__init__. (which will be the docstring inaxes.Axes with my other PR) or in for exampleFigure.add_subplot.

The difference is thatartist.kwdoc(matplotlib.axes.Axes) withrcParams['docstring.hardcopy]=True now renders to lines like
':meth:`yticklabels <matplotlib.axes.Axes.set_yticklabels>` List[str]'
which results in correct links to the documentation compared to the lines before:
':meth:`yticklabels <matplotlib.axes._base._AxesBase.set_yticklabels>` List[str]'
which don't link to a place in the documentation.

Some test code

import matplotlibimport matplotlib.artist as artistimport matplotlib.axes as axesmatplotlib.rcParams['docstring.hardcopy']=Truest=artist.kwdoc(axes.Axes)print(st)matplotlib.rcParams['docstring.hardcopy']=False

@fredrik-1
Copy link
ContributorAuthor

I added some docstrings

@fredrik-1
Copy link
ContributorAuthor

Many links in the kwargs listin don't work. This PR fix those links.

@fredrik-1
Copy link
ContributorAuthor

fredrik-1 commentedJun 19, 2018
edited
Loading

I see now that the kwarg list was actually included in Figure.gca,new,old.

@fredrik-1
Copy link
ContributorAuthor

Could someone review this? This pr make the links in the kwarg lists in forexample work.

@timhoffm
Copy link
Member

I've checked against master and did not see any change in the links. Which ones exactly do not work on master?

@fredrik-1
Copy link
ContributorAuthor

fredrik-1 commentedJul 2, 2018
edited
Loading

axes

For example adjustable in the kwarglist should be a link and this pr fix that.

The same kwarglist with this pr
axes

But what has happend with the rendering of the types in the parameter list? Why are they bold?

@timhoffm
Copy link
Member

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.

@NelleV
Copy link
Member

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)

@NelleVNelleV merged commit2486f89 intomatplotlib:masterJul 13, 2018
@jklymak
Copy link
Member

@NelleV I think that’s true for bare edits of the docs. This was an actual code change for how the docs are handled.

@NelleV
Copy link
Member

Yeah, good point.

@QuLogicQuLogic added this to thev3.0 milestoneJul 13, 2018
@fredrik-1fredrik-1 deleted the kwdoc_bug branchJuly 18, 2018 22:08
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@timhoffmtimhoffmtimhoffm approved these changes

Assignees
No one assigned
Projects
None yet
Milestone
v3.0.0
Development

Successfully merging this pull request may close these issues.

6 participants
@fredrik-1@jklymak@timhoffm@NelleV@QuLogic@dstansby

[8]ページ先頭

©2009-2025 Movatter.jp