ImperialCollegeLondon/PyProBE

Add in-class documentation to Result

Open

#306 opened on Jul 2, 2025

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)Python (19 forks)auto 404
documentationfeaturegood first issue

Repository metrics

Stars
 (51 stars)
PR merge metrics
 (PR metrics pending)

Description

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.

Contributor guide

Research direction
Implement repr and a help method that prints docstrings of available attributes. Look at existing class structure and decide on format for docstring printing.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75