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