Skip to content

Fix typos in the docs/ sub-directory #10485

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 1 commit into from
Jun 23, 2022
Merged

Fix typos in the docs/ sub-directory #10485

merged 1 commit into from
Jun 23, 2022

Conversation

luzpaz
Copy link
Contributor

@luzpaz luzpaz commented Jun 19, 2022

Found via codespell -q 3 -S ./3rd-party,./docs/news -L ans,chello,configury,inout,scoll

@ompiteam-bot
Copy link

Can one of the admins verify this patch?

@jsquyres jsquyres self-requested a review June 22, 2022 14:34
@jsquyres
Copy link
Member

ok to test

@jsquyres
Copy link
Member

@luzpaz These are great -- thank you! Can you make two small updates?

  1. We require a "Signed-off-by" line as a means of agreeing to our Contributor's Declaration: https://github.com/open-mpi/ompi/blob/main/.github/CONTRIBUTING.md#contributors-declaration. Can you amend your commit to include that?
  2. The ReadTheDocs build CI test failed because some of the spelling fixes made the RST title lines be too short. Can you amend those as well? The relevant error message from the RTD CI test is:
/home/docs/checkouts/readthedocs.org/user_builds/ompi/checkouts/10485/docs/faq/running-mpi-apps.rst:1316: WARNING: Title underline too short.

Can I force Aggressive or Degraded performance modes?
----------------------------------------------------
/home/docs/checkouts/readthedocs.org/user_builds/ompi/checkouts/10485/docs/faq/running-mpi-apps.rst:1316: WARNING: Title underline too short.

Can I force Aggressive or Degraded performance modes?
----------------------------------------------------
/home/docs/checkouts/readthedocs.org/user_builds/ompi/checkouts/10485/docs/features/extensions.rst:19: WARNING: Title underline too short.

Available extensions
-------------------

Thank you!

@luzpaz
Copy link
Contributor Author

luzpaz commented Jun 22, 2022

shall i squash and force push ?

@jsquyres
Copy link
Member

shall i squash and force push ?

Yes please.

@luzpaz
Copy link
Contributor Author

luzpaz commented Jun 22, 2022

Sorry, I"m trying to git rebase -i and vscode if hanging forever. Any tips on how to do it manually? 😓

@jsquyres
Copy link
Member

jsquyres commented Jun 22, 2022 •
edited
Loading

Assuming origin is your Git remote for the Open MPI git repo:

shell$ git rebase -i origin/main

should do it for ya.

@luzpaz
Fix typos in the docs/ sub-directory
317832d 
Found via `codespell -q 3 -S ./3rd-party,./docs/news -L ans,chello,configury,inout,scoll`
Fix RST formatting

Signed-off-by: luz paz <luzpaz@pm.me>
@luzpaz
Copy link
Contributor Author

luzpaz commented Jun 22, 2022

Ok, please check. Thanks for the patience

jsquyres
jsquyres approved these changes Jun 22, 2022
View reviewed changes
Copy link
Member

@jsquyres jsquyres left a comment

Choose a reason for hiding this comment

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

Love it -- thank you!

@jsquyres jsquyres merged commit b1b2280 into open-mpi:main Jun 23, 2022
@jsquyres jsquyres mentioned this pull request Jun 23, 2022
Merged
@luzpaz luzpaz deleted the typos/docs branch June 23, 2022 22:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jsquyres jsquyres jsquyres approved these changes

Assignees
No one assigned
Labels
documentation Target: main
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@luzpaz @ompiteam-bot @jsquyres