-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
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
Conversation
There was a problem hiding this 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.
examples/widgets/buttons.py
Outdated
@@ -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. |
There was a problem hiding this comment.
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"
There was a problem hiding this comment.
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.
examples/widgets/slider_demo1.py
Outdated
=========== | ||
Slider Demo | ||
=========== | ||
|
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
Fixed it. Could you please check. |
Hi @ash13 |
3d55690
to
cf356ac
Compare
Thanks @ash13 and @choldgraf ! |
Backport PR #9478 on branch v2.1.0-doc
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