8000 change ginoput docstring to match behavior by xcz011 · Pull Request #14475 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

change ginoput docstring to match behavior #14475

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
Jun 7, 2019
Merged

change ginoput docstring to match behavior #14475

merged 2 commits into from
Jun 7, 2019

Conversation

xcz011
Copy link
Contributor
@xcz011 xcz011 commented Jun 7, 2019

Keep consistance with docstring

PR Summary

close #14467

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with 8000 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

@tacaswell
Copy link
Member

👍 to changing the docstring not the behavior!

@tacaswell tacaswell added this to the v3.2.0 milestone Jun 7, 2019
@tacaswell tacaswell changed the title change ginoput show_clicks default to False change ginoput docstring to match behavior Jun 7, 2019
@tacaswell
Copy link
Member

@xcz011 I took the liberty of changing the PR title to better match what you are doing!

@tacaswell tacaswell modified the milestones: v3.2.0, v3.1.1 Jun 7, 2019
@xcz011
Copy link
Contributor Author
xcz011 commented Jun 7, 2019

@xcz011 I took the liberty of changing the PR title to better match what you are doing!

Thanks !!

dstansby
dstansby approved these changes Jun 7, 2019
View reviewed changes
Copy link
Member
@dstansby dstansby left a comment

Choose a reason for hiding this comment

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

Thanks for the fix 👍

@dstansby dstansby merged commit 0bc9ca2 into matplotlib:master Jun 7, 2019
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Jun 7, 2019
@dstansby
Backport PR matplotlib#14475: change ginoput docstring to match behavior
5705cce
@meeseeksmachine meeseeksmachine mentioned this pull request Jun 7, 2019
Merged
dstansby added a commit that referenced this pull request Jun 7, 2019
@dstansby
Merge pull request #14481 from meeseeksmachine/auto-backport-of-pr-14…
eb5fc6b 
…475-on-v3.1.x

Backport PR #14475 on branch v3.1.x (change ginoput docstring to match behavior)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tacaswell tacaswell tacaswell approved these changes

@dstansby dstansby dstansby approved these changes

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

Successfully merging this pull request may close these issues.

Docs for plt.ginput() have the wrong default value for show_clicks keyword argument.
3 participants
@xcz011 @tacaswell @dstansby
0