pydata/pandas — pull request #4775 by jorisvandenbossche (2013-09-08 16:16:49+00:00)
Title: DOC: some stylistic improvements to docstring rendering in documentation

This is a PR with some stylistic improvements to the docstring rendering in the documentation. The incentive was that I found the reference (docstring) documentation not always clearly organised.

Things I changed (mainly copied from the new numpy/scipy docs):

- reduced space around parameter description
- italic font for parameter types
- assure that colon after "Parameters" is on same line and some grey background in Parameter field to highlight the
- "See also" box: put link and description on same line
- light background color in code examples
- line under Notes and Examples section headers

You can see the result here: http://jorisvandenbossche.github.io/example-pandas-docs/html-docstring-rendering/generated/pandas.DataFrame.apply.html#pandas.DataFrame.apply
and compare with the original: http://pandas.pydata.org/pandas-docs/stable/generated/pandas.DataFrame.apply.html#pandas.DataFrame.apply

Each of the points is of course debatable and I can change some of them back. Maybe the grey background of the code cells (this also applies to the tutorial docs) and the grey highlighting of the "parameter" and "returns" field (this can alse be the full block as in eg http://docs.scipy.org/doc/numpy/reference/generated/numpy.reshape.html#numpy.reshape) is maybe the most debatable.

Style is of course always subjective :-) So what do you think?