You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Would it be OK to change and expose those API docs in the arcade.camera namespace?
I would be +1 on this since deeply nested imports are harder to explore and remember.
Currently the links from the tutorial and programming guide to the camera API docs are broken.
https://api.arcade.academy/en/latest/tutorials/platform_tutorial/step_07.html
https://api.arcade.academy/en/latest/programming_guide/camera.html#key-objects
The reason is that currently the place of exposure in the API docs is
arcade.Camera2D
at the top levelarcade
namespace:https://api.arcade.academy/en/latest/api_docs/api/camera_2d.html#arcade.Camera2D
and other classes & functions are exposed in deeply nested submodules like
arcade.camera.orthographic.OrthographicProjector
:https://api.arcade.academy/en/latest/api_docs/api/advanced_cameras.html#arcade.camera.orthographic.OrthographicProjector
For example here you mention in a changelog to users that objects would be exposed at
arcade.camera.Camera2D
orarcade.camera.OrthographicProjector
:https://github.com/pythonarcade/arcade/blob/development/CHANGELOG.md#camera
Actually all those classes are exposed in the
arcade.camera
namespace already, it's only the docs which are confusing / links broken.Do you want to keep
arcade.Camera2D
or remove it here and only expose it asarcade.camera.Camera2D
?arcade/arcade/__init__.py
Line 225 in f4f4521
For all the others I see somehow you generate
doc/api_docs/api/advanced_cameras.rst
with entries like this:Would it be OK to change and expose those API docs in the
arcade.camera
namespace?I would be +1 on this since deeply nested imports are harder to explore and remember.
Related: #2239
The text was updated successfully, but these errors were encountered: