Closed
Description
What's Broken?
- Typo breaking the syntax
- The example doesn't have a link to it or an example of how to run it
- Multiple typos + broken syntax on https://api.arcade.academy/en/latest/programming_guide/event_loop.html
The page source is https://github.com/pythonarcade/arcade/blob/development/doc/programming_guide/event_loop.rst
Source:
arcade/doc/programming_guide/event_loop.rst
Lines 98 to 105 in 8be3699
Proposed Quick Fix
Note
Since fixes to the update / clock backends are actively being discussed, we'll leave adding a "proper" example thumbnail page till later.
-
s/``fraction``properties/``fraction`` properties/
(add a space) -
Add temp link to GitHub instead of just a literal:
For a visual representation of this, run the `fixed_update_interpolation <https://github.com/pythonarcade/arcade/blob/development/arcade/examples/fixed_update_interpolation.py>`_ example as follows: .. code-block:: shell python -m arcade.examples.fixed_update_interpolation
-
Elaborate on why / what you should pay attention below the code, covering these points:
* It will run very slowly at first
* Watch carefully and pay attention to the right-most yellow circle
* It will not move smoothly -
Add method cross-refs for
on_draw
,on_update
, andon_fixed_update
by filling in the$EVENT_METHOD
name as follows::py:meth:`~Window.$EVENT_METHOD`