MLH-Fellowship / MLH-Fellowship/orientation-project-python-26.SPR.A
Update docstrings to include more detail
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 0
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
Each function will require a docstring. Existing functions with docstrings currently don't explain what the function should do. Update these to include parameters and return statements where necessary.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing functions and reviewing their current docstrings. Update each function's documentation to explain its behavior, parameters, and return value where applicable; the work is done when all functions have sufficiently detailed docstrings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100