ImperialCollegeLondon/PyProBE

Add in-class documentation to Result

Ouverte

#306 ouverte le 2 juil. 2025

Voir sur GitHubGuide contributeur
 (3 commentaires) (0 réaction) (0 personne assignée)Python (19 forks)auto 404
documentationfeaturegood first issue

Métriques du dépôt

Stars
 (51 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Implémentez repr et une méthode help qui affiche les docstrings des attributs disponibles. Examinez la structure de classe existante et décidez du format d'affichage des docstrings.
Stack technique
python
Domaine
backend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75