Re: [Numpy-discussion] Reference guide updated
Ok, thanks. I meant the amount of vertical space between lines of text - for example, the gaps between parameter values and their description, or the large spacing between both lines of text and and the text boxes in the examples section. If other people agree it's a problem, I thought the spacing could be tweaked. It's not a problem that there's more than one function per page. I have been helping out with the docs (where I feel I'm qualified enough - I'm no numpy expert!). I think it will make numpy much easier to learn to have easily-accessible, comprehensive docstrings, and the documentation editor makes it very easy to contribute. I'm also learning a lot reading other people's docstrings :)
It there a reason why there's so much vertical space between all of the text sections? I find the docstrings much easier to read in the editor:
Roughly: * In the editor, you have one function per page, vs several function per page in the reference * in the editor, the blocks 'Parameters', 'Returns'... are considered as sections, while in the reference, they are Field lists (roughly).
In the end, it's only a matter of taste, of course. But you raise an interesting point, we should provide some kind of options to choose between behaviors.
Please note as well that the reference guide is a work in progress: you're more than welcome to join and work with us.
2008/7/24 Neil Crighton <neilcrighton@gmail.com>:
Ok, thanks.
I meant the amount of vertical space between lines of text - for example, the gaps between parameter values and their description, or the large spacing between both lines of text and and the text boxes in the examples section. If other people agree it's a problem, I thought the spacing could be tweaked. It's not a problem that there's more than one function per page.
Feel free to play around with the stylesheet. Download the tarball of the docs here: http://mentat.za.net/numpy/refguide.tar.gz And edit default.css until it looks good. When done, please send me the changes! Cheers Stéfan
participants (2)
-
Neil Crighton
-
Stéfan van der Walt