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

Skip to content

Examples: clarity for 'set and get' example page #17572

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

Conversation

sadielbartholomew
Copy link
Contributor

PR Summary

I found the 'Set And Get' example page confusing, as much of the wording implies that the methods are set & get rather than setp and getp, e.g:

  • "set operates on a single instance or a list of instances";
  • "get returns the value of a given attribute. You can use get to query the value of a single attribute".

This PR makes a few changes to make the text clear, including by making the method names explicit with monospace formatting. (Also, as per the current formatting guide, converts the amended & clearer title to 'upper lower' case).

I am happy to amend it if, & as, requested, but in general I think the wording should be clearer. Thanks.

PR Checklist

[Only one checklist item applicable:]

- [ ] 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

@jklymak jklymak added this to the v3.4.0 milestone Jun 4, 2020
Copy link
Member

@jklymak jklymak left a comment

Choose a reason for hiding this comment

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

Seems reasonable, post CI

@story645 story645 merged commit 5e046f7 into matplotlib:master Jun 4, 2020
@story645
Copy link
Member

story645 commented Jun 4, 2020

Thank you for your PR! πŸ₯³ 🎊

@sadielbartholomew sadielbartholomew deleted the setp-and-getp-example-clarity branch June 4, 2020 19:32
@QuLogic QuLogic modified the milestones: v3.4.0, v3.3.0 Jun 4, 2020
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