Documentation in Code
Last updated on 2022-11-15 | Edit this page
Estimated time: 0 minutes
Documenting for collaboration
Overview
Questions
- How should I document my code in the files?
Objectives
- Outline new functions with comment psuedocode
- Create numpydoc friendly docstrings
- explain the steps,
- psuedocode
API Documentation
Doctrings Numpydoc syntax
Key Points
- Docstrings describe functions
- comments throughout the code help onboard and debug