POSYDON-code/POSYDON

Reformating and updating all docstrings + adding missing ones.

Aberta

#187 aberto em 8 de nov. de 2023

Ver no GitHub
 (1 comentário) (0 reação) (1 responsável)Python (35 forks)auto 404
P2 - medium prioritydocumentationenhancementgood first issue

Métricas do repositório

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

Description

With the automatic creation of the reference from the docstrings we need to check them:

  • check format:
    • here I already checked the format of citations
    • mainly checking the correct indentation, missing black lines, and other warnings and errors
  • update information, e.g. some have more parameters then explained, or some contain outdated information or the information is too much/less detailed
  • add missing ones

Guia do colaborador

Direção de pesquisa
Revise os docstrings de cada módulo quanto ao formato e completeza. Use ferramentas como pydocstyle para verificar a formatação. Atualize parâmetros e descrições de acordo com o código mais recente.
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.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75