Documentation in Code

Overview

Teaching: 0 min
Exercises: 0 min

Questions

• How should I document my code in the files?

Objectives

• Outline new functions with comment psuedocode

• Create numpydoc friendly docstrings

Documenting for collaboration

• explain the steps,
• psuedocode

API Documentation

Doctrings Numpydoc syntax

Key Points

• Docstrings describe functions

• comments throughout the code help onboard and debug