Skip to content

Added description to widget example programs except Cursor and Menu #9478

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 3 commits into from
Oct 21, 2017

Conversation

ash13
Copy link
Contributor

@ash13 ash13 commented Oct 19, 2017

PR Summary

Was working on #8921 to add one line description for the example programs: I worked on the example programs related to widgets. I was not able to check the Curosr and the menu widget. Other than those widgets, I have added description to the rest. Please do review and let me know if it needs any changes.

examples/widgets/buttons.py - Done
examples/widgets/check_buttons.py - Done
examples/widgets/cursor.py - Had few errors in my system. Will work on it. Not done.
examples/widgets/lasso_selector_demo_sgskip.py - Done
examples/widgets/menu.py - Din't work on my system. Will work on it.
examples/widgets/multicursor.py - Done
examples/widgets/radio_buttons.py - Done
examples/widgets/slider_demo.py- Done
examples/widgets/textbox.py - Done

LINK: #8921

PR Checklist

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

Copy link
Contributor

@divyam3897 divyam3897 left a comment

Choose a reason for hiding this comment

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

You can remove the part "An example.." and keep only the description part.

@@ -2,7 +2,7 @@
=======
Buttons
=======

An pretty cool example to show how to use buttons widget.The program shows a simple GUI with a sine wave changing its frequency.The next and previous button widget used here helps shows the wave with new frequency.
Copy link
Contributor

Choose a reason for hiding this comment

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

An pretty cool? You should not have had the first line, a small description should be there. Don't use the words like "an example to show etc"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry it was 'A' . And yes will remove the first line.

===========
Slider Demo
===========

Copy link
Contributor

Choose a reason for hiding this comment

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

There is no description added, why changes in the whole file?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry about that. I think I din't save the changes. I will fix it.

@dstansby dstansby added this to the v2.1.0-doc milestone Oct 19, 2017
@ash13
Copy link
Contributor Author

ash13 commented Oct 19, 2017

Fixed it. Could you please check.

@NelleV
Copy link
Member

NelleV commented Oct 19, 2017

Hi @ash13
We are following the pep8 conventions in our code. The lines should be max 79 char long, so the description you've added are too long. Do you mind breaking the lines?

@choldgraf choldgraf force-pushed the example-programs-fix branch from 3d55690 to cf356ac Compare October 21, 2017 17:54
@NelleV NelleV modified the milestones: v2.1.0-doc, v2.2 Oct 21, 2017
@NelleV NelleV merged commit 8bc197a into matplotlib:master Oct 21, 2017
@NelleV
Copy link
Member

NelleV commented Oct 21, 2017

Thanks @ash13 and @choldgraf !

lumberbot-app bot pushed a commit that referenced this pull request Oct 21, 2017
tacaswell added a commit that referenced this pull request Oct 21, 2017
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.

5 participants