search

Colorbleed / fusionless

Python in Black Magic Design's Fusion that sucks less.
Other
15 stars 3 forks source link

Deciding on documentation style (docstrings) #2

Open BigRoy opened 9 years ago

BigRoy commented 9 years ago

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

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 commented 9 years ago

+1 for Google Style

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

ftouvet commented 8 years ago

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

BigRoy commented 8 years ago

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 commented 8 years ago

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