Documentation and Docstring Format
Josef Skladanka
jskladan at redhat.com
Thu Apr 17 09:31:30 UTC 2014
> https://pythonhosted.org/an_example_pypi_project/sphinx.html#auto-directives
>
>
> I'm not suggesting that we drop everything and fix all the docstrings
> right now but I am suggesting that we start following the sphinx
> docstring format for new code and fix other-formatted docstrings as we
> come across them.
>
> Any objections?
Well, my only objection is, that the Sphinx format has IMHO the worst impact on how docstrings look.
Maybe it is just me, but I use help() more often than html docs.
But other than that, I have no issues.
J.
More information about the qa-devel
mailing list