Convert Docstrings to Numpy Style

[meatballs]

Our docstrings currently use a variety of formats and we should agree a standard.

My suggestion is that we use Numpydoc (https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt) since it's the closest to anything we currently have.

Tasks required are:

1. Agree the standard we're adopting
2. Tidy up the existing docstrings to meet that standard
3. Add some instructions to docs/contributing.rst

[drvinceknight]

I'm happy with the suggested format.

[langner]

+1

[marcharper]

👍

[meatballs]

I reckon we can close this one now. Anyone object?

[drvinceknight]

Fine by me.

[marcharper]

Have we converted them all?

[drvinceknight]

Fair point. I don't believe we have for everything. Main components: I
believe we have but not all strategies for example.

On Mon, 25 Jul 2016, 16:56 Marc Harper, notifications@github.com wrote:

Have we converted them all?

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
#347 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/ACCGWiYt3hoILfeden-S_5JWSBwRWPFvks5qZNy3gaJpZM4GJk94
.

[drvinceknight]

I'll pick this up next.