statsmodels/statsmodels

DOC: docstrings in robust.norms, improve, reorganize

Fechada

#8.807 aberto em 17 de abr. de 2023

Ver no GitHubGuia do colaborador
 (11 comentários) (0 reação) (0 responsável)Python (2.831 forks)batch import
comp-docscomp-robustgood first issue

Métricas do repositório

Stars
 (9.176 estrelas)
Métricas de merge de PR
 (Mesclagem média 3d) (45 fundiu PRs em 30d)

Description

The docstrings for methods in robust norm have the formulas in the Returns section.

Would be better before Parameter section as extended description. Also converting to math will look better if we can get table formatting of equations (align for z ... in piecewise functions)

Guia do colaborador

Direção de pesquisa
Foque no módulo robust.norms no statsmodels. Examine as docstrings existentes dos métodos nesse módulo para entender o posicionamento atual das fórmulas. A issue pede para mover as fórmulas da seção Returns para uma descrição estendida antes da seção Parameters e usar formatação matemática para melhor legibilidade, especialmente para funções por partes. Verifique se o repositório usa reStructuredText com o papel :math: ou LaTeX matemático. Revise quaisquer comentários na issue para orientações adicionais.
Pilha de tecnologia
python
Domain
documentation
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 docstring conventionsreStructuredText basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90