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

Appearance settings

Improve docs on gridspec #14449

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

Merged
merged 1 commit into from
Jun 6, 2019
Merged

Improve docs on gridspec #14449

merged 1 commit into from
Jun 6, 2019

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Jun 4, 2019

PR Summary

Would still benefit from more cleanup. But that's for some later time.


`SubplotSpec`
specifies the location of the subplot in the given `GridSpec`.
The `GridSpec` specifies the overall grid structure. Individual cells within
Copy link
Member Author

Choose a reason for hiding this comment

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

The classes including their first-line description are listed in the sphinx doc here anyway. There's no need to explicitly copy them here. Instead, just briefly describe the conceptual purpose.

@timhoffm timhoffm added this to the v3.1.1 milestone Jun 4, 2019
@dstansby
Copy link
Member

dstansby commented Jun 5, 2019

Looks like the doc build isn't happy:
/home/circleci/project/lib/matplotlib/gridspec.py:docstring of matplotlib.gridspec:1: WARNING: more than one target found for cross-reference 'Axes': mpl_toolkits.axes_grid1.mpl_axes.Axes, mpl_toolkits.axisartist.axislines.Axes, matplotlib.axes.Axes

@timhoffm
Copy link
Member Author

timhoffm commented Jun 5, 2019

@dstansby Thanks, fixed.

@jklymak jklymak merged commit 0536a66 into matplotlib:master Jun 6, 2019
@lumberbot-app
Copy link

lumberbot-app bot commented Jun 6, 2019

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
$ git checkout v3.1.x
$ git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
$ git cherry-pick -m1 0536a669742e88e56a9e080580dbba727c9f33cd
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
$ git commit -am 'Backport PR #14449: Improve docs on gridspec'
  1. Push to a named branch :
git push YOURFORK v3.1.x:auto-backport-of-pr-14449-on-v3.1.x
  1. Create a PR against branch v3.1.x, I would have named this PR:

"Backport PR #14449 on branch v3.1.x"

And apply the correct labels and milestones.

Congratulation you did some good work ! Hopefully your backport PR will be tested by the continuous integration and merged soon!

If these instruction are inaccurate, feel free to suggest an improvement.

timhoffm pushed a commit to timhoffm/matplotlib that referenced this pull request Jun 6, 2019
@timhoffm timhoffm deleted the doc-gridspec branch June 6, 2019 20:52
dstansby added a commit that referenced this pull request Jun 7, 2019
…v3.1.x

Backport PR #14449: Improve docs on gridspec
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.