Skip to content

Instantly share code, notes, and snippets.

@asinghvi17

asinghvi17/what-do-i-do.md

Created October 11, 2024 20:20
Show Gist options
  • Save asinghvi17/082496d54f117a135170d8987ae88c23 to your computer and use it in GitHub Desktop.
Save asinghvi17/082496d54f117a135170d8987ae88c23 to your computer and use it in GitHub Desktop.
Download ZIP
Minimum criteria for docstrings
Raw
what-do-i-do.md

Minimum criteria for docstrings

  • Must have a usage example of real use - what the hell do I do with this?
  • If user-facing, must explain package-specific concepts (this can be a few words but it has to be done, since people will come in with no knowledge of package internals)
  • If output is a custom type, must mention what it is and what you can do with it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment