Skip to content

Commit b031c96

Browse files
authored
Center shields.io elements in the README.md file and grammar fixes for multiple documents. (#2471)
* Update shields.io elements to align in center in README.md * Rephrase answers for easier understanding * Remove wordiness and rephrase for better understanding. * Grammar, spelling and phrasing fixes. * Reorder words. * Capitalize GitHub * More grammar/spelling/rephrase edits for CONTRIBUTING.md * Remove wordiness in CODE_OF_CONDUCT.md while keeping its message. * Remove extra spaces, different choice of words and other minor fixes. * All changes PVC requested. * Remove curly quotes
1 parent e202cfc commit b031c96

8 files changed

+35
-32
lines changed

CHANGELOG.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Version 3.0.0 is a major update to Arcade. It breaks compatibility with the 2.6
1111
These are the breaking API changes. Use this as a quick reference for updating 2.6 code. You can find more details in later sections. Lots of behavior has changed even if the interface hasn't. If you are porting old code, read through these logs thoroughly.
1212

1313
* Dropped Python 3.8 support completely.
14-
* Texture management has completely changed in 3.0. In the past, we
14+
* Texture management has completely changed in 3.0. In the past, we
1515
cached everything, which caused issues for larger
1616
projects that needed memory management. Functions like `Arcade.load_texture` no longer cache textures.
1717
* Removed the poorly named `Window.set_viewport` and `set_viewport` methods.
@@ -234,7 +234,7 @@ These are the breaking API changes. Use this as a quick reference for updating 2
234234
### Controller Input
235235

236236
Previously, controllers were usable via the `Arcade.joysticks` module. This module is still available in 3.0.
237-
However, most people can treat it as depreciated. It is an alias to Pyglet's joysticks sub-module. There is now an `arcade.controller` module that is an alias to Pyglet's new Controller API. This change should make a more comprehensive selection of controllers usable with Arcade. The joystick module may still be helpful if you need specialty controllers such as racing wheels or flight sticks. The example code now uses the new controller AP.
237+
However, most people can treat it as depreciated. It is an alias to Pyglet's joysticks sub-module. There is now an `arcade.controller` module that is an alias to Pyglet's new Controller API. This change should make a more comprehensive choice of controllers usable with Arcade. The joystick module may still be helpful if you need specialty controllers such as racing wheels or flight sticks. The example code now uses the new controller AP.
238238

239239
### Text
240240

@@ -320,7 +320,7 @@ We would also like to thank the contributors who spent their valuable time solvi
320320
#### Notable contributors:
321321
* [DarkLight1337](https://github.com/DarkLight1337) helped the team untangle type annotation issues for cameras
322322
* [Mohammad Ibrahim](https://github.com/Ibrahim2750mi) was a massive help with the GUI and various other parts of the library.
323-
* [ryyst](https://github.com/ryyst) completely revitalised the Arcade Docs.
323+
* [ryyst](https://github.com/ryyst) completely revitalized the Arcade Docs.
324324

325325
#### Contributors
326326

CODE_OF_CONDUCT.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Our Pledge
44

55
In the interest of fostering an open and welcoming environment, we as
6-
contributors and maintainers pledge to making participation in our project and
6+
contributors and maintainers pledge to make participation in our project and
77
our community a harassment-free experience for everyone, regardless of age, body
88
size, disability, ethnicity, sex characteristics, gender identity and expression,
99
level of experience, education, socio-economic status, nationality, personal
@@ -56,8 +56,7 @@ a project may be further defined and clarified by project maintainers.
5656

5757
Instances of abusive, harassing, or otherwise unacceptable behavior may be
5858
reported by contacting the project team at [email protected]. All
59-
complaints will be reviewed and investigated and will result in a response that
60-
is deemed necessary and appropriate to the circumstances. The project team is
59+
complaints will be reviewed and investigated and will result in a response deemed necessary and appropriate to the circumstances. The project team is
6160
obligated to maintain confidentiality with regard to the reporter of an incident.
6261
Further details of specific enforcement policies may be posted separately.
6362

CONTRIBUTING.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Arcade welcomes contributions, including:
1111
If you're looking for a way to contribute, try checking
1212
[the currently active issues](https://github.com/pythonarcade/arcade/issues)
1313
for one that needs work. If you're new to programming or contributing, check for the
14-
label `good first issue`, these are issues which have been identified as good candidates for first time contributors.
14+
label `good first issue`, these are issues that have been identified as good candidates for first time contributors.
1515

1616
Notifying us about issues in the code and documentation is also a valuable contribution.
1717

@@ -88,14 +88,14 @@ See [this link](https://black.readthedocs.io/en/stable/integrations/editors.html
8888
Black integration for your specific editor.
8989

9090
The following command will run black for you if you do not want to configure your editor to do it. It can be
91-
a good idea to run this command when you are finished working anyways, as our CI will use this to check that
91+
a good idea to run this command when you are finished working anyway, as our CI will use this to check that
9292
the formatting is correct.
9393

9494
```bash
9595
python make.py format
9696
```
9797

98-
In addition to Black, this will sort the imports using [Ruff](https://docs.astral.sh/ruff/). If you want to setup
98+
In addition to Black, this will sort the imports using [Ruff](https://docs.astral.sh/ruff/). If you want to set up
9999
your editor to run this, please see [this link](https://docs.astral.sh/ruff/integrations/) for more information on
100100
Ruff integration for your specific editor.
101101

@@ -111,12 +111,12 @@ Args:
111111
```
112112

113113
* `Args:` should be used for all parameters
114-
* `Returns:` can be used if the return value needs additional explanation outside of
115-
the current docstring. If the return type is already clear from type annotation it
114+
* `Returns:` can be used if the return value needs additional explanation outside
115+
the current docstring. If the return type is already clear from type annotation, it
116116
can be omitted.
117117
* `Raises:` can be used if the function raises exceptions that need to be documented
118118
* `Yields:` can be used if the function is a generator and yields values
119-
* `Attributes:` we should try to avoid and instead document the attributes in the code
119+
* `Attributes:` we should try to avoid it and instead document the attributes in the code
120120
* Types are visible in the api docs. It's not mandatory to include types in docstring,
121121
however, simple types like `int`, `str`, `float`, `bool` can be included.
122122
* Using `optional` is a good way to indicate that a parameter is optional.
@@ -145,8 +145,8 @@ more discussion on this topic.
145145
# type: ignore # pending https://github.com/pyglet/pyglet/issues/843
146146
```
147147

148-
This links to an issue in the 3rd party library that is causing the type error.
149-
This oddly-specific syntax is compatible with both mypy and pyright.
148+
This links to an issue in the third party library that is causing the type error.
149+
This oddly specific syntax is compatible with both mypy and pyright.
150150
See [this issue](https://github.com/pythonarcade/arcade/issues/1789) for more information.
151151

152152
### Use pre-commit hooks to automatically run formatting
@@ -181,7 +181,7 @@ in this repo for current tests.
181181

182182
First, run the below command to run our linting tools automatically. This will run Mypy
183183
and Ruff against Arcade. The first run of this may take some as MyPy will not have any
184-
caches built up. Sub-sequent runs will be much faster.
184+
caches built up. Subsequent runs will be much faster.
185185

186186
```bash
187187
python make.py lint
@@ -266,7 +266,7 @@ sudo apt install texlive-latex-extra
266266
To reduce the large (300 MB+) install size of the second package, you
267267
may be able to use the `--no-install-recommends` flag.
268268

269-
Other platforms may require different install steps.
269+
Other platforms may require different installation steps.
270270

271271
##### Building
272272

ISSUE_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## System Info
44

5-
Run this and paste the output here: python -m arcade
5+
Run `python -m arcade` and paste the output here.
66

77
### Actual behavior:
88

README.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# Welcome to The Arcade Library!
22

3-
![MIT License](https://img.shields.io/pypi/l/arcade)
4-
[<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="Pull Requests Welcome">](http://makeapullrequest.com)
5-
[<img src="https://img.shields.io/badge/first--timers--only-friendly-blue.svg" alt="First Timers Friendly">](http://www.firsttimersonly.com/)
3+
<p align="center">
4+
<img src="https://img.shields.io/pypi/l/arcade">
5+
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="http://makeapullrequest.com">
6+
<img src="https://img.shields.io/badge/first--timers--only-friendly-blue.svg" alt=http://www.firsttimersonly.com/">
7+
</p>
68

79
Arcade is an easy-to-learn Python library for creating 2D video games.
8-
It is ideal for beginning programmers, or programmers who want to create
10+
It is ideal for beginning programmers or programmers who want to create
911
2D games without learning a complex framework.
1012

1113
[pyglet]: https://github.com/pyglet/pyglet
@@ -15,8 +17,12 @@ for example game jam entries and more.
1517

1618
[Arcade Discord Server]: https://discord.gg/ZjGDqMp
1719

18-
![PyPI - Downloads](https://img.shields.io/pypi/dm/arcade)
19-
![GitHub Commit Activity](https://img.shields.io/github/commit-activity/m/pythonarcade/arcade)
20+
<p align="center">
21+
<img src="https://img.shields.io/pypi/dm/arcade">
22+
<img src="https://img.shields.io/github/commit-activity/m/pythonarcade/arcade">
23+
<img src="https://img.shields.io/github/contributors/pythonarcade/arcade">
24+
<img src="https://img.shields.io/github/stars/pythonarcade/arcade">
25+
</p>
2026

2127
## Stable Documentation
2228

RELEASE_CHECKLIST.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@
1111
9. Update version number in `arcade/version.py`
1212
10. Update :ref:`release_notes` with release dates and any additional
1313
info needed.
14-
11. Make sure last check-in ran clean on github actions, viewable on Discord
14+
11. Make sure last check-in ran clean on GitHub actions, viewable on Discord
1515
12. Merge development branch into maintenance.
1616
13. Add label to release
17-
14. Push code. Check for clean compile on github.
17+
14. Push code. Check for clean compile on GitHub.
1818
15. Type `make clean`
1919
16. Type `make dist`
2020
17. Type `make deploy_pypi`

doc/about/faq.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,6 @@ Even adapted versions of Arcade or parts of it can be used in commercial project
2424
Can I use Arcade resources in my own educational materials?
2525
-----------------------------------------------------------
2626

27-
Yes! Arcade was primarily developed for educational purposes.
28-
Use Arcade materials in any way you see fit. Original content
29-
or adapted versions of it.
27+
Of course! Arcade was built to support learning.
28+
You can use its materials however you need—
29+
whether you stick with the original content or make changes to suit your needs.

doc/about/intro.rst

+2-4
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,8 @@ of resources to help you learn.
2020
Community driven
2121
----------------
2222

23-
Arcade is a community driven project. We cannot exist without the help of our users.
24-
You don't need to be an experienced programmer or a game developer to help us.
25-
You can help us by reporting bugs, suggesting improvements, pointing out issues
26-
in documentation or even by sharing your projects with us.
23+
Arcade is a community-driven project, and we rely on support from users like you.
24+
You don't need to be an expert programmer or game developer to contribute.
2725

2826
* More information about ways to contribute: :ref:`how-to-contribute`.
2927
* Also see :ref:`community-locations` for more information about where to find the

0 commit comments

Comments
 (0)