On 14/12/13 11:15, Txema Vicente wrote: > 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 don't like the chosen color for some of the elements: #44A. It looks too close to the "standard" color for a visited link. Also I think non-link elements (ie. headers) should have a different colour. I kind of like the set of colors used in existing docs (black for headers, blueish #005B81 for the links, but may be is just because I'm used to them. In my browser I see links in a slightly bigger font size and it doesn't look too good :( Checking the CSS, the computed font size for regular text is 14px but the links are 16px. Could be related to default font sizes in my browser? The code examples look nice with the yellow bg, although it's a little bit too bright. #FFFDDD is easier for my eyes at least. I hope this feedback helps! > 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? I don't have any preference, although cleaning up the existing comments could be a pain. I usually follow the style of the comments around the code I'm commenting, but sometimes is not easy because of epydoc leftovers or because it looks like two different styles have been used for the same thing. I definitely like the idea of the style guide. Go for it! Regards, Juan -- jjm's home: http://www.usebox.net/jjm/ blackshell: http://blackshell.usebox.net/ -- 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.
