Skip to content

Instantly share code, notes, and snippets.

@bhstahl
Created January 29, 2015 14:13
Show Gist options
  • Save bhstahl/b658910acb5e0fd4e5f4 to your computer and use it in GitHub Desktop.
Save bhstahl/b658910acb5e0fd4e5f4 to your computer and use it in GitHub Desktop.
Javadoc Style Documentation For Python
<snippet>
<content><![CDATA[
"""
Some description of what this function
does in great, explicit detail.
@type a: number
@param a: Some number used.
@type b: string
@param b: Some string used.
@rtype: string
@return: Some string returned.
"""
]]></content>
<tabTrigger>pydoc</tabTrigger>
<scope>source.python</scope>
</snippet>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment