Skip to content

DOC: update typos and grammar errors #24782

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Dec 21, 2022
Merged

DOC: update typos and grammar errors #24782

merged 5 commits into from
Dec 21, 2022

Conversation

AdvancedUno
Copy link
Contributor

@AdvancedUno AdvancedUno commented Dec 20, 2022 •
edited
Loading

PR Summary

#24762
Fix a typo and grammar errors on #24762

- Making an new branch for each set of related changes will make it easier for
+ Making a new branch for each set of related changes will make it easier for

-Enter a title for the set of changes, and some explanation of what you've done.
-Say if there is anything you'd like particular attention for - like a
+Enter a title for a set of changes with some explanation of what you've done.
+Mention anything you'd like particular attention for - such as a

-There's an embarrassing typo in a commit you made? Or perhaps the you
-made several false starts you would like the posterity not to see.
+Is there any embarrassing typo in a commit you made? Or perhaps you
+made several false starts you don't want posterity to see.

-and the history looks now like this::
+and now, history looks like this::

-history will get messy. Most of the time you can just ask for a review, and not
-worry that ``main`` has got a little ahead.  But sometimes, the changes in
+history will get messy. Most of the time, you can just ask for a review without
+worrying about whether ``main`` has got a little ahead; however sometimes, the changes in

-When all looks good you can delete your backup branch::
+When all looks good, you can delete your backup branch::

-branch *cool-feature*.  If you try to push the new commits to GitHub it will
-fail with an error that looks like ::
+branch *cool-feature*.  If you try to push the new commits to GitHub, it will
+fail and show an error that looks like ::

-If this push had succeed then the commits ``A``, ``B``, and ``C`` would no
-longer be referenced by any branch and be discarded:
+If this push had succeeded, the commits ``A``, ``B``, and ``C`` would no
+longer be referenced by any branch and they would be discarded:

-However, in the case of having intentionally re-written history we *want* to
+However, in the case of having intentionally re-written history, we *want* to

-versions from our local branch.  In this case, what we want to do is ::
+versions from our local branches.  In this case, what we want to do is ::

-history and if anyone has fetched the old commits will have a different view
+history, and if anyone has fetched the old commits, it will have a different view

PR Checklist

Documentation and Tests

  • [N/A] Has pytest style unit tests (and pytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • [N/A] New plotting related features are documented with examples.

Release Notes

  • [N/A] New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • [N/A] API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • [N/A] Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

github-actions[bot]
github-actions bot reviewed Dec 20, 2022
View reviewed changes
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

QuLogic
QuLogic reviewed Dec 20, 2022
View reviewed changes
AdvancedUno and others added 4 commits December 20, 2022 17:10
@AdvancedUno @QuLogic
Update doc/devel/development_workflow.rst
b96f7c5 
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
@AdvancedUno @QuLogic
Update doc/devel/development_workflow.rst
90ef26a 
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
@AdvancedUno @QuLogic
Update doc/devel/development_workflow.rst
b18fed6 
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
@AdvancedUno @QuLogic
Update doc/devel/development_workflow.rst
a610992 
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
@AdvancedUno
Copy link
Contributor Author

@QuLogic Thank you for your help!

@timhoffm timhoffm added this to the v3.6-doc milestone Dec 21, 2022
@timhoffm timhoffm merged commit f2cd380 into matplotlib:main Dec 21, 2022
@timhoffm
Copy link
Member

Thanks @AdvancedUno and congratulations on your first contribution to Matplotlib!

@lumberbot-app
Copy link

lumberbot-app bot commented Dec 21, 2022

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.6.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 f2cd3803b4527ecf86bbb092ebc3db345569ca05
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #24782: DOC: update typos and grammar errors'
  1. Push to a named branch:
git push YOURFORK v3.6.x:auto-backport-of-pr-24782-on-v3.6.x
  1. Create a PR against branch v3.6.x, I would have named this PR:

"Backport PR #24782 on branch v3.6.x (DOC: update typos and grammar errors)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

@lumberbot-app
Copy link

lumberbot-app bot commented Dec 21, 2022

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.6.2-doc
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 f2cd3803b4527ecf86bbb092ebc3db345569ca05
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #24782: DOC: update typos and grammar errors'
  1. Push to a named branch:
git push YOURFORK v3.6.2-doc:auto-backport-of-pr-24782-on-v3.6.2-doc
  1. Create a PR against branch v3.6.2-doc, I would have named this PR:

"Backport PR #24782 on branch v3.6.2-doc (DOC: update typos and grammar errors)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

@AdvancedUno
Copy link
Contributor Author

@timhoffm Thank you!! Glad to be helpful!

@timhoffm timhoffm modified the milestones: v3.6-doc, v3.7.0 Dec 21, 2022
@QuLogic QuLogic mentioned this pull request Dec 22, 2022
Closed
@saranti
Copy link
Contributor

saranti commented Dec 22, 2022

@QuLogic

I'm going to assume this is fully fixed by #24782.

There are still some issues:

-Enter a title for a set of changes with some explanation of what you've done.
-Mention anything you'd like particular attention for - such as a
+Enter a title for the set of changes with some explanation of what you've done.
+Mention anything you'd like particular attention paid to - such as a

-worrying about whether ``main`` has got a little ahead; however sometimes, the changes in
-``main`` might affect your changes, and you need to harmonize them.  In this
-situation you may prefer to do a rebase.
+worrying about whether ``main`` has gotten a little ahead; however sometimes, the changes in
+``main`` might affect your changes and you need to harmonize them.  In this
+situation, you may prefer to do a rebase.

-fail and show an error that looks like ::
+fail and show an error that looks like::

-versions from our local branch.  In this case, what we want to do is ::
+versions from our local branch.  In this case, what we want to do is::

-history, and if anyone has fetched the old commits, it will have a different view
+history, and if anyone has fetched the old commits, they will have a different view

After this, it'll be perfect

@AdvancedUno AdvancedUno deleted the updatedoc branch December 23, 2022 03:05
@AdvancedUno AdvancedUno restored the updatedoc branch December 23, 2022 03:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@QuLogic QuLogic QuLogic left review comments

@github-actions github-actions[bot] github-actions[bot] left review comments

@timhoffm timhoffm timhoffm approved these changes

Assignees
No one assigned
Labels
None yet
Projects
First Time Contributors
Status: Merged
Milestone
v3.7.0
Development

Successfully merging this pull request may close these issues.
5 participants
@AdvancedUno @timhoffm @saranti @QuLogic @DoingFineLee