ImperialCollegeLondon / ImperialCollegeLondon/PyProBE

Add in-class documentation to Result

Open
#306 3 comments 0 reactions 0 assignees View on GitHub
documentation feature good first issue
Dominant language
Python
Stars
56
Forks
20
PR merge metrics
No merged PRs in 30d

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

Open the contributing guide

Research direction

Start by locating the Result class and reviewing its available attributes, existing class methods, and API documentation. Clarify the intended behavior of __repr__, help(), and what_can_i_do(), then consider the work complete when these entry points document the available API as described.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.