SpockBotMC / SpockBot

High level Python framework for building Minecraft clients and bots.
MIT License
198 stars 47 forks source link

Switch to Google Python Docstrings #131

Closed gamingrobot closed 9 years ago

gamingrobot commented 9 years ago

I am not a huge fan of sphinx docstrings and readthedocs supports Google Python style docstrings

Example here

Sphinx Extension for converting docstrings https://sphinxcontrib-napoleon.readthedocs.org

Thoughts?

Gjum commented 9 years ago

Looks like something I've been wanting for a long time.

txomon commented 9 years ago

I would avoid such a verbose documentation, we are still in pre v1, things and APIs are changing still. High level documentation would be more appropriate IMO. I would leave functions for later =)

gamingrobot commented 9 years ago

All done, see #165