Skip to content
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

Update README.md #640

Closed
wants to merge 1 commit into from
Closed

Conversation

JosephBJoyce
Copy link
Contributor

Fix typos

✈️ Pre-flight checklist

  • [x ] I have read the Contributing Guidelines on pull requests.
  • [NA] If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • [NA] If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

📝 Summary

Just fixing a few typos and (hopefully) improving the readability of README.md.

Fix typos
@JP-Ellis
Copy link
Contributor

JP-Ellis commented Apr 2, 2024

Thanks for this! Improvements to the docs are much appreciated, and often undervalued.

The timing here is somewhat unfortunately as I am in the final stages of a major rewrite of the docs over in #414. So I am unfortunately going to close this PR without merging. I hope you understand.

Having said that, your work is not lost and I did double check the typos you reported and made sure they are not reproduced in the new docs I have cherry picked your changes into the PR.

Additionally, I most likely have introduced a bunch of new typos as well, so once the other PR is merged, you are more than welcome to fix any/all new typos 😆

@JP-Ellis JP-Ellis closed this Apr 2, 2024
@JosephBJoyce
Copy link
Contributor Author

JosephBJoyce commented Apr 2, 2024

No problem, JP; thanks for the feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants