ImperialCollegeLondon/PyProBE

Add in-class documentation to Result

Offen

#306 geöffnet am 02.07.2025

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (19 Forks)auto 404
documentationfeaturegood first issue

Repository-Metriken

Stars
 (51 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Implementieren Sie repr und eine Hilfsmethode, die die Docstrings der verfügbaren Attribute ausgibt. Sehen Sie sich die vorhandene Klassenstruktur an und entscheiden Sie über das Format für die Docstring Ausgabe.
Tech Stack
python
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75