Skip to content

Instantly share code, notes, and snippets.

@hguochen

hguochen/reST documentation format

Last active August 29, 2015 14:10
Show Gist options
  • Save hguochen/f864f63d837e84bf5bce to your computer and use it in GitHub Desktop.
Save hguochen/f864f63d837e84bf5bce to your computer and use it in GitHub Desktop.
Download ZIP
reST style documentation format
Raw
reST documentation format
"""
This is a reST style.
:param param1: this is a first param
:param param2: this is a second param
:returns: this is a description of what is returned
:raises keyError: raises an exception
"""
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment