Deciding on documentation style (docstrings)

[BigRoy]

Currently I'm using a heavily reStructuredText driven docstring style but looking over how it looks in the code I'm thinking about swapping over to the Google Style Docstrings.

Google Style Docstrings

• Example Google Style Python Docstrings
• Google Python Style Guide

reStructuredText Docstrings

• PEP 0287 -- reStructuredText Docstring Format

The nice thing of reStructuredText over Google Style is that it's easily supported for autodoc in sphinx. Plus it's supported directly in IDEs like PyCharm while Google Style is not supported in PyCharm.

[mottosso]

+1 for Google Style

It's supported by Sphinx, I'm using it for Pyblish.

• http://api.pyblish.com/en/latest/

[ftouvet]

is it me or Google Style is "just" an indented reStructuredText?

[BigRoy]

is it me or Google Style is "just" an indented reStructuredText?

@ftouvet Haha, kind off I guess. Less dots and symbols here and there. Supposedly more readable within the code.

Anyway, I'll move towards Google style down the line since there doesn't seem to be any current opposition...

[BigRoy]

I'll be moving forward to Googley style docstrings over time. As I cleanup some code I'll refactor docstrings accordingly.