I have found some lost docstrings: module variables (see pyglet.app) and
bound methods (see pyglet.gl.gl_info Functions). This is now fixed in
the repo.
I started to modify docstrings, I`ve touched pyglet.app and .canvas.
This is how it looks:
http://code.nabla.net/doc/testing/pyglet/api/pyglet/pyglet.canvas.html
New CSS is OK?
I think we should modify the docstrings to:
* Create API references:
- Function -> :func:`pyglet.app.run` (Specify the module if not
defined in this one)
- Class -> :class:`Display`
- Methods -> :meth:`Display.get_screens`
- Attributtes -> :attr:`platform_event_loop`
* All :Ivariables: blocks should be revised:
- If it is a class parameter, should be at :parameters: of __init__.
- If it is an instance attributte, move the text to the attr docstring,
- If it is important, leave the text as class docstring and
reference :attr:
The official ReST directives are valid, plus some pyglet specific
conversions,
for example now :parameters: is converted to :param x:, :type x:
I will write a 'style guide' to explain this.
Comments?
--
You received this message because you are subscribed to the Google Groups
"pyglet-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/pyglet-users.
For more options, visit https://groups.google.com/groups/opt_out.
