ImperialCollegeLondon/PyProBE

Add in-class documentation to Result

オープン

#306 opened on 2025/07/02

GitHub で見るコントリビューターガイド
 (3 件のコメント) (0 件のリアクション) (0 人の担当者)Python (19 件のフォーク)auto 404
documentationfeaturegood first issue

Repository metrics

Stars
 (51 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Python
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75