This repository has been archived by the owner on Nov 10, 2022. It is now read-only.

Cleanup doc strings #4

Open

clburlison opened this issue Feb 23, 2018 · 1 comment

Labels

Owner

clburlison commented Feb 23, 2018

Use Google's style guide https://google.github.io/styleguide/pyguide.html?showone=Comments#Comments

"""
This is an example of Google style.

Args:
    param1: This is the first param.
    param2: This is a second param.

Returns:
    This is a description of what is returned.

Raises:
    KeyError: Raises an exception.

"""

Owner Author

clburlison commented Mar 20, 2018

This extension is great https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring

clburlison added the enhancement label

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.