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.
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
pyglet needs a full docstring review and cleanup #1084
Comments
Starting on shapes. |
First pass of |
|
finished |
Finished |
Starting on |
Finished the |
Working on |
First pass of |
TL;DR:
|
While reviewing my open issues v.s. issues here, I stumbled upon here and it struck a humble chord: Maybe someone can obviate in PlatformEventLoop.notify's docstring whether this is a method that user code should ever call? Do all docstrings end up on the online documentation, or is there a syntax which excludes a docstring for when it's too low level a class member? |
Okay, read better above now, this is out of scope. |
pyglet has gone through several documentation build tools in its life, leading to variation in the docstrings across the library.
Currently we use Sphinx to build the docs, which is capable of building a variety of formats. This works for the most part but, with recent additions of type hints across the library, there is a lot of inconsistency with how the API docs are rendering.
The purpose of this ticket is to get the ball rolling on a full review and refactoring of the docstrings. This can be done in multiple parts.
rst
style, but will potentially change. This link is here, but will need to be updated after 1. is complete: https://pyglet.readthedocs.io/en/latest/internal/doc.htmlThe text was updated successfully, but these errors were encountered: