ImperialCollegeLondon/PyProBE

Add in-class documentation to Result

Aperta

#306 aperta il 2 lug 2025

Vedi su GitHubGuida contributor
 (3 commenti) (0 reazioni) (0 assegnatari)Python (19 fork)auto 404
documentationfeaturegood first issue

Metriche repository

Star
 (51 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Implementa repr e un metodo help che stampi i docstring degli attributi disponibili. Controlla la struttura della classe esistente e decidi il formato per la stampa dei docstring.
Tech stack
python
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75