@@ -11,7 +11,7 @@ Arcade welcomes contributions, including:
1111If you're looking for a way to contribute, try checking
1212[ the currently active issues] ( https://github.com/pythonarcade/arcade/issues )
1313for 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
1616Notifying us about issues in the code and documentation is also a valuable contribution.
1717
@@ -112,11 +112,11 @@ Args:
112112
113113* ` Args: ` should be used for all parameters
114114* ` 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
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.
150150See [ this issue] ( https://github.com/pythonarcade/arcade/issues/1789 ) for more information.
151151
152152### Use pre-commit hooks to automatically run formatting
0 commit comments