JuliaDynamics/ComplexityMeasures.jl

Consistent formatting for `InformationMeasure`s

Aberta

#303 aberto em 25 de ago. de 2023

Ver no GitHubGuia do colaborador
 (1 comentário) (1 reação) (0 responsável)Julia (19 forks)auto 404
documentationgood first issue

Métricas do repositório

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

Description

Some of the entropy and extropy definitions have really nice docstrings that clearly outline all formulas, assumptions and meanings of symbols. The Renyi and Tsallis entropies are good examples.

However, several of the information measures don't explain what symbols mean and are formatted differently (without a ## Description header). It would be nice to have consistent formatting and explanations.

Guia do colaborador

Direção de pesquisa
Identifique as definições de medidas de informação com formatação inconsistente e atualize suas docstrings para seguir o estilo usado pelas entropias de Renyi e Tsallis, adicionando um cabeçalho ## Description e explicando os símbolos.
Pilha de tecnologia
None
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.
1
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.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90