Skip to content

Improve scene object annotations & docstrings #1802

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

Merged
merged 32 commits into from
Jun 6, 2023
Merged

Improve scene object annotations & docstrings #1802

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
06bd7e4
Fix top-level docstring of Scene object by rewriting it
pushfoo May 27, 2023
f4e417d
Rewrite __len__'s docstring to use plain english
pushfoo May 27, 2023
c71e007
Rewrite Scene.__delitem__ docstring for clarity
pushfoo May 27, 2023
1f9eed2
Rephrase Scene's top-level docstring to be more accurate
pushfoo May 27, 2023
7177901
Shorten & clarify Scene.from_tilemap docstring
pushfoo May 27, 2023
8e98283
Clarify Scene.get_sprite_list docstring
pushfoo May 27, 2023
97f2e2b
Rephrase Scene.add_sprite docstring and link relevant methods
pushfoo May 27, 2023
3e1bb0c
Improve Scene.remove_sprite_list_by_* docstrings
pushfoo May 27, 2023
afda951
Improve Scene's update function docstrings & annotations
pushfoo May 27, 2023
df86cc8
Update docstring & typing for Scene.draw
pushfoo May 27, 2023
9ce269a
Rephrase top-level Scene module docstring
pushfoo May 27, 2023
f7dfda6
Rewrite Scene's top-level docstring again for clarity and accuracy
pushfoo May 27, 2023
38ecbb6
Use KeyError in Scene.move_sprite_list_before
pushfoo Jun 2, 2023
152b434
Raise KeyError when before not in Scene + improve move_sprite_list_be…
pushfoo Jun 2, 2023
9132974
Add a templating exception subclass
pushfoo Jun 2, 2023
b4507ff
Add same modifications to move_sprite_list_after
pushfoo Jun 2, 2023
c598531
Fix a doc build issue
pushfoo Jun 2, 2023
3b8bcc5
Add SceneKeyError to arcade.__all__
pushfoo Jun 6, 2023
b9e40e9
Add example & improve clarity in SceneKeyError's docstring
pushfoo Jun 6, 2023
f2a8439
Additional rephrasing for the top-level docstring
pushfoo Jun 6, 2023
bced9c1
Rephrase __delitem__ docstring
pushfoo Jun 6, 2023
cbd04ad
Fix escapes in from_tilemap docstring
pushfoo Jun 6, 2023
4f66a45
Replace redundant escape in get_sprite_list docstring
pushfoo Jun 6, 2023
5e66617
Fix redundant escapes & typo in __getitem__ docstring
pushfoo Jun 6, 2023
5e18d73
Touch up add_sprite's docstring
pushfoo Jun 6, 2023
037088e
Rephrase add_sprite_list_before docstring
pushfoo Jun 6, 2023
3db20bf
Touch up multiple method docstrings
pushfoo Jun 6, 2023
c3a9eb2
Remove types from docstrings per #1796 + typo fixes
pushfoo Jun 6, 2023
e4a422d
Redo the annotations & docstring for draw_hit_boxes
pushfoo Jun 6, 2023
49fca92
Rephrase names attribute param documentation
pushfoo Jun 6, 2023
079f8af
Use SceneKeyError in place of a raw KeyError
pushfoo Jun 6, 2023
7adbf42
Fix typos in add_sprite_list docstring
pushfoo Jun 6, 2023
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
2 changes: 2 additions & 0 deletions arcade/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ def configure_logging(level: Optional[int] = None):
from .sprite_list import SpatialHash

from .scene import Scene
from .scene import SceneKeyError

from .physics_engines import PhysicsEnginePlatformer
from .physics_engines import PhysicsEngineSimple
Expand Down Expand Up @@ -260,6 +261,7 @@ def configure_logging(level: Optional[int] = None):
'Section',
'SectionManager',
'Scene',
'SceneKeyError',
'Sound',
'BasicSprite',
'Sprite',
Expand Down
Loading