This lesson is still being designed and assembled (Pre-Alpha version)

Documentation in Code


Teaching: 0 min
Exercises: 0 min
  • How should I document my code in the files?

  • Outline new functions with comment psuedocode

  • Create numpydoc friendly docstrings

Documenting for collaboration

API Documentation

Doctrings Numpydoc syntax

Key Points

  • Docstrings describe functions

  • comments throughout the code help onboard and debug