Docstrings should use Napoleon syntax

EliAndrewC / sideboard

BSD 3-Clause "New" or "Revised" License

0 stars 0 forks source link

Docstrings should use Napoleon syntax #27

Closed EliAndrewC closed 8 years ago

EliAndrewC commented 10 years ago

We have a lot of docstrings for things in sideboard.lib, and I really like the formatting examples for https://pypi.python.org/pypi/sphinxcontrib-napoleon so I think we should start using that.

Rob Ruana will like this, since that's his project :)

robdennis commented 10 years ago

Make this say sideboard

On Mon, Mar 24, 2014 at 7:05 PM, Eli Courtwright notifications@github.com wrote:

We have a lot of docstrings for things in dradis.lib, and I really like the formatting examples for https://pypi.python.org/pypi/sphinxcontrib-napoleon so I think we should start using that.

Rob Ruana will like this, since that's his project :)

Reply to this email directly or view it on GitHub: https://github.com/appliedsec/sideboard/issues/27

EliAndrewC commented 10 years ago

Good catch, thanks, don't want to confuse anyone.

EliAndrewC commented 8 years ago

Moved to https://github.com/magfest/sideboard/issues/37