lchtangen / lchtangen/SampleMind-AI---Beta
Add missing docstrings to utility functions
Open
Nobody has claimed this yet.
beginner
documentation
good first issue
- Dominant language
- Python
- Stars
- 1
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Description:
Add comprehensive docstrings to all functions in the file picker utility.
Tasks:
- Add docstrings following Google style
- Include parameter types and return types
- Add usage examples
File: src/samplemind/utils/file_picker.py
Difficulty: 🟢 Beginner
Time: 30-60 minutes
See docs/GOOD_FIRST_ISSUES.md Issue #1 for details.
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
Open src/samplemind/utils/file_picker.py and review every function. Add Google-style docstrings with parameter types, return types, and usage examples; completion means all functions in that file are documented consistently. Use docs/GOOD_FIRST_ISSUES.md Issue #1 for the stated task details.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100