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

Skip to content

Minor fix to ginput_demo. #11926

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
Aug 24, 2018
Merged

Minor fix to ginput_demo. #11926

merged 1 commit into from
Aug 24, 2018

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Aug 23, 2018

  1. The sentence in the docstring is both incomplete(?) (at least it ends
    with a comma...) and adding no information; just remove it.
  2. Print slightly more detailed instructions.

Could probably be further improved, or just removed, but heh...

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

1) The sentence in the docstring is both incomplete(?) (at least it ends
with a comma...) and adding no information; just remove it.
2) Print slightly more detailed instructions.

Could probably be further improved, or just removed, but heh...
@jklymak jklymak merged commit 8d1ceb0 into matplotlib:master Aug 24, 2018
@jklymak
Copy link
Member

jklymak commented Aug 24, 2018

Merging for now, but agree that it could go away...

@anntzer anntzer deleted the ginput-demo branch August 24, 2018 23:30
@timhoffm
Copy link
Member

timhoffm commented Aug 25, 2018

Generally, I think that every example needs an explanatory text. While "This provides examples of uses of interactive functions, such as ginput." is not great, it at least gave a bit of context. Just removing the text makes it worse.

I'm gonna open a PR to remove the example completely. IMHO it does not illustrate anything reasonable, so it should better go away.

@QuLogic QuLogic added this to the v3.1 milestone Aug 25, 2018
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.

4 participants