Copy-edit various examples. #27268
Merged
Copy-edit various examples. #27268
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
story645
reviewed
Nov 5, 2023
galleries/examples/color/README.txt
Outdated
| @@ -3,6 +3,6 @@ | |||
| Color | |||
| ===== | |||
|
|
|||
| For more in-depth information about the colormaps available in matplotlib | |||
| For more in-depth information about the colormaps available in Matplotlib | |||
There was a problem hiding this comment.
Suggested change
| For more in-depth information about the colormaps available in Matplotlib | |
| For more in-depth information about the built in colormaps |
if the goal is removing reduncancy?
There was a problem hiding this comment.
If you have to say "builtin" it's not really better than "in Matplotlib", so we may as well be explicit here.
| @@ -3,7 +3,7 @@ | |||
| List of named colors | |||
| ==================== | |||
|
|
|||
| This plots a list of the named colors supported in matplotlib. | |||
| This plots a list of the named colors supported by Matplotlib. | |||
There was a problem hiding this comment.
Suggested change
| This plots a list of the named colors supported by Matplotlib. | |
| This plots a list of the supported named colors. |
same?
There was a problem hiding this comment.
ditto re "supported".
Comment on lines
12
to
13
| This legend guide extends the `~.Axes.legend` docstring - | ||
| please read it first before proceeding with this guide. |
There was a problem hiding this comment.
Suggested change
| This legend guide extends the `~.Axes.legend` docstring - | |
| please read it first before proceeding with this guide. | |
| This legend guide extends the `~.Axes.legend` docstring - | |
| please read it before proceeding with this guide. |
| @@ -62,7 +59,7 @@ | |||
| line_down, = ax.plot([3, 2, 1], label='Line 1') | |||
| ax.legend(handles=[line_up, line_down]) | |||
|
|
|||
| In some cases, it is not possible to set the label of the handle, so it is | |||
| Rarely, it is not possible to set the label of the handle, so it is | |||
There was a problem hiding this comment.
Suggested change
| Rarely, it is not possible to set the label of the handle, so it is | |
| Rarely, it is not possible to set the label of the handle, so it is |
I think there's a weird double negation going on here and this sentence may be clearer if it were not inverted, something like
While usually the label is set on the handle, in rare instances you may need to pass through a list of labels
| @@ -21,11 +21,10 @@ | |||
| Simple Example | |||
| ============== | |||
|
|
|||
| In matplotlib, the location of axes (including subplots) are specified in | |||
| In Matplotlib, the location of Axes (including subplots) are specified in | |||
There was a problem hiding this comment.
Suggested change
| In Matplotlib, the location of Axes (including subplots) are specified in | |
| the location of Axes (including subplots) are specified in |
There was a problem hiding this comment.
Actually the whole sentence is a bit pointless here, removed it and reworded the following one.
Mostly removing "in Matplotlib" (where it is clear that it's a Matplotlib example illustrating how to do stuff in Matplotlib), and removing redundant subtitles.
story645
approved these changes
Nov 5, 2023
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Nov 5, 2023
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Nov 5, 2023
story645
added a commit
that referenced
this pull request
Nov 5, 2023
…268-on-v3.8.x Backport PR #27268 on branch v3.8.x (Copy-edit various examples.)
story645
added a commit
that referenced
this pull request
Nov 5, 2023
…268-on-v3.8.1-doc Backport PR #27268 on branch v3.8.1-doc (Copy-edit various examples.)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Mostly removing "in Matplotlib" (where it is clear that it's a Matplotlib example illustrating how to do stuff in Matplotlib), and removing redundant subtitles.
PR summary
PR checklist