Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC: make Line2D docstring definition easier to find #12067

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Sep 8, 2018
Merged

DOC: make Line2D docstring definition easier to find #12067

merged 2 commits into from
Sep 8, 2018

Conversation

jklymak
Copy link
Member

@jklymak jklymak commented Sep 7, 2018

PR Summary

As above, I could never find the where the docstring interpolation is defined. Now maybe my bad for not knowing the convention, but I think this is actually easier to follow.

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 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

@jklymak jklymak force-pushed the doc-moresearchable-Line2Ds branch from 17a7750 to 385c623 Compare September 7, 2018 23:29
ivanov
ivanov approved these changes Sep 8, 2018
View reviewed changes
Copy link
Member

@ivanov ivanov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great to me, @jklymak! I took the liberty of pushing in a commit to also fix all instances of the indentation anomalies that @anntzer had fixed for spy in #12066.

@ivanov
Copy link
Member

ivanov commented Sep 8, 2018

That previous spy dedent is the one that's conflicting, but the resolution is simple enough (just go with the version here).

@jklymak jklymak force-pushed the doc-moresearchable-Line2Ds branch from 09b6397 to e7069a7 Compare September 8, 2018 15:22
@jklymak
Copy link
Member Author

jklymak commented Sep 8, 2018

Thanks @ivanov pushed the rebase w/ the indent set properly.

phobson
phobson reviewed Sep 8, 2018
View reviewed changes
Copy link
Member

@phobson phobson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great
https://13268-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/api/_as_gen/matplotlib.axes.Axes.axhline.html?highlight=axhline#matplotlib.axes.Axes.axhline

@phobson
Copy link
Member

phobson commented Sep 8, 2018

Wait, is this still a WIP?

If not, someone hit the merge button.

@jklymak jklymak changed the title WIP: DOC: make Line2D docstring definition easier to find DOC: make Line2D docstring definition easier to find Sep 8, 2018
@jklymak
Copy link
Member Author

jklymak commented Sep 8, 2018

Sorry, not WIP. OTOH I'll not merge, because its possible someone doesn't agree w/ this change. ping @anntzer @timhoffm who follow the docstring interpolation closely....

@anntzer
Copy link
Contributor

anntzer commented Sep 8, 2018

I'm fine with the PR.

timhoffm
timhoffm approved these changes Sep 8, 2018
View reviewed changes
Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! That‘s fine for now. In the long run, we should probably do some changes in the interpolation mechanism. But till then, this is an improvement already.

@timhoffm timhoffm merged commit 7fe3dd2 into matplotlib:master Sep 8, 2018
@QuLogic QuLogic added this to the v3.1 milestone Sep 9, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ivanov ivanov ivanov approved these changes

@phobson phobson phobson approved these changes

@timhoffm timhoffm timhoffm approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.1.0
Development

Successfully merging this pull request may close these issues.
6 participants
@jklymak @ivanov @phobson @anntzer @timhoffm @QuLogic