MLH-Fellowship / MLH-Fellowship/orientation-project-python-25.SPR.A
Update docstrings to include more detail
Open
Nobody has claimed this yet.
bug
good first issue
- Dominant language
- Python
- Stars
- 1
- Forks
- 7
- 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
No source files or tests are identified in the issue. First locate the Python functions that already have docstrings and those missing them, then check the project's documentation conventions; done means every function has a detailed docstring covering parameters and return values where applicable.
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