lchtangen/SampleMind-AI---Beta

Add missing docstrings to utility functions

Open

#1 创建于 2025年10月4日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Python (2 fork)auto 404
beginnerdocumentationgood first issue

仓库指标

Star
 (1 star)
PR 合并指标
 (PR 指标待抓取)

描述

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.

贡献者指南

研究方向
查看Google Python文档字符串样式指南，并检查代码库中现有的文档字符串以了解模式。然后按照相同样式为src/samplemind/utils/file picker.py中的所有函数添加文档字符串。
技术栈
python
领域
backend
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1 小时以内
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
新近可参与
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
PythonGoogle style docstrings
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90