MLH-Fellowship / MLH-Fellowship/orientation-project-python-24.SPR.B
Update docstrings to include more detail
Open
Nobody has claimed this yet.
bug
good first issue
- Dominant language
- Python
- Stars
- 2
- Forks
- 6
- 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 reviewing the repository's Python functions and their existing docstrings; the issue does not identify specific files or entry points. Inventory functions lacking docstrings or parameter and return details, then update the relevant documentation so each function explains its parameters, return value, and behavior where necessary.
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