Examples: clarity for 'set and get' example page #17572
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
I found the 'Set And Get' example page confusing, as much of the wording implies that the methods are
set
&get
rather thansetp
andgetp
, e.g: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- [ ] 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