ImperialCollegeLondon/PyProBE

Add in-class documentation to Result

Aberta

#306 aberto em 2 de jul. de 2025

Ver no GitHubGuia do colaborador
 (3 comentários) (0 reação) (0 responsável)Python (19 forks)auto 404
documentationfeaturegood first issue

Métricas do repositório

Stars
 (51 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Implemente repr e um método help que imprima as docstrings dos atributos disponíveis. Verifique a estrutura da classe existente e decida o formato para impressão das docstrings.
Pilha de tecnologia
python
Domain
backend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Python
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75