Documentation in Code

Estimated time: 0 minutes

Overview

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