docs: add style guide instructions for writing Python docstrings

[AlexTereshenkov]

Add some practical advice on how to edit the docstrings for the reference docs so that we could refer to this page when needed.

[AlexTereshenkov]

Is there anything that you think would be worth adding?

[thejcannon]

I love that you're writing this. It'll be really nice to add to our dev docs. One big nit though.

You keep using "docstrings", but I think you mean "help strings". Docstrings are strings in specific places, that eventually become some objects __doc__. These are just strings provided to functions.

Can you replace "docstrings" with "help strings"? Then, it's good to go from me. (And thanks again)

[AlexTereshenkov]

I love that you're writing this. It'll be really nice to add to our dev docs. One big nit though.

You keep using "docstrings", but I think you mean "help strings". Docstrings are strings in specific places, that eventually become some objects __doc__. These are just strings provided to functions.

Can you replace "docstrings" with "help strings"? Then, it's good to go from me. (And thanks again)

Oh yes, indeed, this is a much better wording, 100% agreed. Fixed!

Replaced "docstrings" with "help strings"

[thejcannon]

Lgtm