Deciding on DocString style

[sdhutchins]

I think pycharm is using rest? docstring (for restructured text). @grabear

def function():
  """This function does something.

    :param name: The name to use.
    :type name: str.
    :param state: Current state to be in.
    :type state: bool.
    :returns:  int -- the return code.
    :raises: AttributeError, KeyError

    """

Are you okay with this format since you're already using similar? I'm going to work on adding to all the docstrings I've written. Won't be hard.

Also, there's an example here. Since we're already using sphinx for documentation, I think it'd be great to use it.

[grabear]

Yea PyCharm uses Restructured text by default. However, you can use the other ones as well:

But i do like restructured text. So yea... I'm unfamiliar with sphinx, but I'll look into when I do my next docstring patch.

[grabear]

Also PyCharm has some sphinx stuff built in:

[sdhutchins]

Awesome. Yeah, Sphinx uses restructured text so it's a perfect fit. When I get ready to change those docstrings, I'll be sure to do in PyCharm. That seems significantly easier. I'll close out this issue now unless you have any more thoughts about code style.

[grabear]

Well you can check this box in PyCharm:

And whenever you autogenerate the docstrings (trible-double quotes + ENTER), it will auto add the type.

But thats all I've got.

[sdhutchins]

That's very helpful. I'll have to make note of this when I start out.