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

Jump to bottom
Merged
merged 32 commits into from
Jun 6, 2023
Merged

Improve scene object annotations & docstrings #1802

merged 32 commits into from
Jun 6, 2023

Conversation

pushfoo
Copy link
Member

@pushfoo pushfoo commented May 27, 2023 •
edited
Loading

Changes

  • Rewrite multiple docstrings for clarity & precision
  • Add links to other relevant sections of arcade & python doc
  • Add missing keyword arguments & type annotations to Scene.draw

How to test

  1. Build & serve doc locally with ./make.py serve
  2. Open http://localhost:8000/api_docs/api/sprite_scenes.html#arcade.Scene in your browser
  3. Check for anything wrong

Progress

  • Top-level docstring
  • Sprite list addition docstrings
  • Dunder docstrings
  • Drawing docstrings
  • get_* docstrings
  • Take care of move_* function docstrings
  • Find & fix any remaining docstrings & annotation in need of attention
  • Double check backtick formatting for variables displaying as italics

@pushfoo pushfoo force-pushed the improve_scene_object_docstrings branch from 20823bd to 048247e Compare June 2, 2023 14:23
pushfoo added 17 commits June 5, 2023 20:09
@pushfoo
Fix top-level docstring of Scene object by rewriting it
06bd7e4
@pushfoo
Rewrite __len__'s docstring to use plain english
f4e417d
@pushfoo
Rewrite Scene.__delitem__ docstring for clarity
c71e007
@pushfoo
Rephrase Scene's top-level docstring to be more accurate
1f9eed2
@pushfoo
Shorten & clarify Scene.from_tilemap docstring
7177901
@pushfoo
Clarify Scene.get_sprite_list docstring
8e98283
@pushfoo
Rephrase Scene.add_sprite docstring and link relevant methods
97f2e2b
@pushfoo
Improve Scene.remove_sprite_list_by_* docstrings
3e1bb0c
@pushfoo
Improve Scene's update function docstrings & annotations
afda951
@pushfoo
Update docstring & typing for Scene.draw
df86cc8
@pushfoo
Rephrase top-level Scene module docstring
9ce269a
@pushfoo
Rewrite Scene's top-level docstring again for clarity and accuracy
f7dfda6
@pushfoo
Use KeyError in Scene.move_sprite_list_before
38ecbb6
@pushfoo
Raise KeyError when before not in Scene + improve move_sprite_list_be…
152b434 
…fore docstring
@pushfoo
Add a templating exception subclass
9132974
@pushfoo
Add same modifications to move_sprite_list_after
b4507ff
@pushfoo
Fix a doc build issue
c598531
@pushfoo pushfoo force-pushed the improve_scene_object_docstrings branch from 048247e to c598531 Compare June 6, 2023 00:10
@pushfoo pushfoo marked this pull request as ready for review June 6, 2023 01:53
@pvcraven pvcraven merged commit 7753e92 into pythonarcade:development Jun 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@pushfoo @pvcraven