MLH-Fellowship / MLH-Fellowship/orientation-project-python-23.FAL.B
Update docstrings to include more detail
Open
Nobody has claimed this yet.
bug
good first issue
- Dominant language
- Python
- Stars
- 0
- Forks
- 1
- 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 Python functions in the repository and reviewing which ones lack docstrings or have incomplete ones. Update the documented functions with their parameters and return information where necessary; done means each function has a sufficiently detailed docstring.
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