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