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
Older Sphinx versions, including pyglet's, do not report correct locations for syntax errors. Upgrading to 6.2.1 or later should fix some of the worst of these (see sphinx-doc/sphinx#11026).
Why this is relevant
It's annoying when working on doc
It has been discussed without objections before on Discord
It delays PRs when people unfamiliar with the problem run into it (see this example from arcade)
For an example of how this affects our current code:
/home/pushfoo/src/pyglet/pyglet/graphics/shader.py:docstring of pyglet.graphics.shader.Attribute:1: WARNING: Definition list ends without a blank line; unexpected unindent.
However, there is no definition list at line 1 of Attribute's docstring:
Older Sphinx versions, including pyglet's, do not report correct locations for syntax errors. Upgrading to 6.2.1 or later should fix some of the worst of these (see sphinx-doc/sphinx#11026).
Why this is relevant
For an example of how this affects our current code:
/home/pushfoo/src/pyglet/pyglet/graphics/shader.py:docstring of pyglet.graphics.shader.Attribute:1: WARNING: Definition list ends without a blank line; unexpected unindent.
However, there is no definition list at line 1 of Attribute's docstring:
pyglet/pyglet/graphics/shader.py
Lines 151 to 153 in 66466f8
Tasks required
To my understanding per prior discussion on Discord:
This implies we have to update the following:
The text was updated successfully, but these errors were encountered: