Improve scene object annotations & docstrings (#1802)

* Fix top-level docstring of Scene object by rewriting it

* Rewrite __len__'s docstring to use plain english

* Rewrite Scene.__delitem__ docstring for clarity

* Rephrase Scene's top-level docstring to be more accurate

* Shorten & clarify Scene.from_tilemap docstring

* Clarify Scene.get_sprite_list docstring

* Rephrase Scene.add_sprite docstring and link relevant methods

* Improve Scene.remove_sprite_list_by_* docstrings

* Improve Scene's update function docstrings & annotations

* Update docstring & typing for Scene.draw

* Rephrase top-level Scene module docstring

* Rewrite Scene's top-level docstring again for clarity and accuracy

* Use KeyError in Scene.move_sprite_list_before

* Raise KeyError when before not in Scene + improve move_sprite_list_before docstring

* Add a templating exception subclass

* Add same modifications to move_sprite_list_after

* Fix a doc build issue

* Add SceneKeyError to arcade.__all__

* Add example & improve clarity in SceneKeyError's docstring

* Additional rephrasing for the top-level docstring

* Rephrase __delitem__ docstring

* Fix escapes in from_tilemap docstring

* Replace redundant escape in get_sprite_list docstring

* Fix redundant escapes & typo in __getitem__ docstring

* Touch up add_sprite's docstring

* Rephrase add_sprite_list_before docstring

* Touch up multiple method docstrings

* Remove types from docstrings per #1796 + typo fixes

* Redo the annotations & docstring for draw_hit_boxes

* Rephrase names attribute param documentation

* Use SceneKeyError in place of a raw KeyError

* Fix typos in add_sprite_list docstring

Author: pushfoo

arcade/__init__.py

@@ -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
@@ -260,6 +261,7 @@ def configure_logging(level: Optional[int] = None):
     'Section',
     'SectionManager',
     'Scene',
+    'SceneKeyError',
     'Sound',
     'BasicSprite',
     'Sprite',