lchtangen/SampleMind-AI---Beta

Add missing docstrings to utility functions

Open

#1 opened on Oct 4, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (2 forks)auto 404
beginnerdocumentationgood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

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

Research direction
Review the Google Python docstring style guide and examine existing docstrings in the codebase for patterns. Then add docstrings to all functions in src/samplemind/utils/file picker.py following the same style.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGoogle style docstrings
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90