Skip to content

Instantly share code, notes, and snippets.

@aaronlelevier
Created April 21, 2017 17:48
Show Gist options
  • Select an option

  • Save aaronlelevier/5b26389cfadd2937ac3906c70c16d198 to your computer and use it in GitHub Desktop.

Select an option

Save aaronlelevier/5b26389cfadd2937ac3906c70c16d198 to your computer and use it in GitHub Desktop.
Eample Python docstring from Google's guidlines
def func(x, y, *args, **kwargs):
    """Summary
    
    Parameters:
      x (int) : first parameter
      y: second parameter
        with longer description
        
    Raises:
     Exception: if anything bad happens
    Returns:
      None: always   
    """
    pass

Other documentation formatting examples linked in this SO answer:

http://stackoverflow.com/a/34212785/1913888

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