Skip to content

Avoid really long lines in event handling docs. #15535

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 1 commit into from
Oct 27, 2019
Merged

Avoid really long lines in event handling docs. #15535

merged 1 commit into from
Oct 27, 2019

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Oct 27, 2019

We don't need to be strict with the line length in rst files, but it's
still nice to stay within reasonable bounds.

PR Summary

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

timhoffm
timhoffm approved these changes Oct 27, 2019
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.

Optional additional improvement: Make „Class and description“ separate columns. Increases readability and the source is even a bit shorter.

@anntzer
Avoid really long lines in event handling docs.
5b5df4b 
We don't need to be strict with the line length in rst files, but it's
still nice to stay within reasonable bounds.
@anntzer anntzer force-pushed the event-handling-docs branch from 0056025 to 5b5df4b Compare October 27, 2019 14:51
@anntzer
Copy link
Contributor Author

anntzer commented Oct 27, 2019

sure, done

1 similar comment
@anntzer
Copy link
Contributor Author

anntzer commented Oct 27, 2019

sure, done

@timhoffm timhoffm added this to the v3.1-doc milestone Oct 27, 2019
@timhoffm timhoffm merged commit 8189ef1 into matplotlib:master Oct 27, 2019
@lumberbot-app
Copy link

lumberbot-app bot commented Oct 27, 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 8189ef1ecacdbcc9e4c846db75f9db608dd5e48a
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
$ git commit -am 'Backport PR #15535: Avoid really long lines in event handling docs.'
  1. Push to a named branch :
git push YOURFORK v3.1.x:auto-backport-of-pr-15535-on-v3.1.x
  1. Create a PR against branch v3.1.x, I would have named this PR:

"Backport PR #15535 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.

@lumberbot-app
Copy link

lumberbot-app bot commented Oct 27, 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.1-doc
$ git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
$ git cherry-pick -m1 8189ef1ecacdbcc9e4c846db75f9db608dd5e48a
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
$ git commit -am 'Backport PR #15535: Avoid really long lines in event handling docs.'
  1. Push to a named branch :
git push YOURFORK v3.1.1-doc:auto-backport-of-pr-15535-on-v3.1.1-doc
  1. Create a PR against branch v3.1.1-doc, I would have named this PR:

"Backport PR #15535 on branch v3.1.1-doc"

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.

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Oct 27, 2019
@timhoffm
Backport PR matplotlib#15535: Avoid really long lines in event handli…
2783e4e 
…ng docs.
@meeseeksmachine meeseeksmachine mentioned this pull request Oct 27, 2019
Merged
@timhoffm timhoffm modified the milestones: v3.1-doc, v3.2.0 Oct 27, 2019
@timhoffm
Copy link
Member

It's not worth the effort of a manual backport, so it will only go back to v.3.2.0.

@anntzer anntzer deleted the event-handling-docs branch October 27, 2019 15:56
dstansby added a commit that referenced this pull request Oct 27, 2019
@dstansby
Merge pull request #15538 from meeseeksmachine/auto-backport-of-pr-15…
f53f5e9 
…535-on-v3.2.x

Backport PR #15535 on branch v3.2.x (Avoid really long lines in event handling docs.)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timhoffm timhoffm timhoffm approved these changes

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

Successfully merging this pull request may close these issues.
2 participants
@anntzer @timhoffm