kitsuta
commented
8 years ago Related to this, I wonder if we can configure PyCharm to use the Google or NumPy (I prefer Google) docstring format for when you're inserting docstrings. The docstring insertion is super handy and it'd be nice if it used the nicer format by default. I'll look into this briefly but Dom may know how to do it out of hand - it's apparently configured in the Python Integrated Tools plugin here: https://www.jetbrains.com/help/pycharm/2016.1/python-integrated-tools.html
Moved here from the original (now private) issue tracker.
We have a lot of docstrings (though we should really add more), and I really like the formatting examples for https://pypi.python.org/pypi/sphinxcontrib-napoleon so I think we should start using that. Seriously, check out how much nicer it looks than ReStructuredText.
This would also be a really good opportunity for a newcomer to div into the Sideboard codebase and see what it's doing, since it'll force you to read through and understand the docs!