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 punctuation in some docs #2919

Merged
merged 5 commits into from
Jun 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,16 +43,16 @@ Sphinx has a good ReStructed Text primer to learn the basics:
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

Contributing steps:
- Have an idea to improve the docs, perhaps create an issue on Github
- Find the file you want to edit: it will most likely be in `docs/reST/ref`.
- Have an idea to improve the docs, perhaps create an issue on Github.
- Find the file you want to edit. It will most likely be in `docs/reST/ref`.
OR
- Pygame docs pages have an "Edit on Github" button, which will show you the file
- Pygame docs pages have an "Edit on Github" button, which will show you the file.
- Download the pygame source from Github locally.
^ One way to do this is to fork and use a Git client to make that a local repository
^ One way to do this is to fork and use a Git client to make that a local repository.
- Implement your idea.
- Follow the steps in "Generating the Documentation"
^ This is important to test your changes work well
- Commit your changes, create a pull request
- Follow the steps in "Generating the Documentation" above.
^ This is important to test that your changes work well.
- Commit your changes, create a pull request.

## Documentation Style

Expand Down