Write Docstrings for All Public Functions markdown Copy Edit #5
Description
Task
Add clear and complete docstrings for all public functions in jam.py and app.py.
Goal
Help developers understand the purpose, inputs, and outputs of each function, improving code readability and documentation.
Suggested Approach
- For each function, write a docstring that includes:
- A short description of the function's purpose
- Descriptions of parameters (with types)
- The return value and its type
- Follow the Google or NumPy docstring style guide.
Requirements
- Basic understanding of Python functions.
- Familiarity with docstring standards.
References
Difficulty
Beginner
If you're new to open source, check out our Contributing Guide in the repository. Feel free to ask questions in our Discord: https://discord.gg/GgB8hbvR