ImperialCollegeLondon/PyProBE

Add in-class documentation to Result

開放

#306 建立於 2025年7月2日

在 GitHub 查看貢獻者指南
 (3 則留言) (0 個反應) (0 位負責人)Python (19 個分叉)auto 404
documentationfeaturegood first issue

倉庫指標

星標
 (51 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

This task is to enable class magic methods like __repr__ and to create help() or what_can_i_do() methods that print the doc strings of available attributes and encourage use of the API documentation.

貢獻者指南

研究方向
實現 repr 和一個列印可用屬性文件字串的幫助方法。查看現有類別結構並決定文件字串列印的格式。
技術棧
python
領域
backend
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
新近可參與
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Python
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75