JuliaDynamics/ComplexityMeasures.jl

Consistent formatting for `InformationMeasure`s

Aperta

#303 aperta il 25 ago 2023

Vedi su GitHubGuida contributor
 (1 commento) (1 reazione) (0 assegnatari)Julia (19 fork)auto 404
documentationgood first issue

Metriche repository

Star
 (79 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Identifica le definizioni di misure informative con formattazione incoerente e aggiorna i loro docstring per seguire lo stile usato dalle entropie di Renyi e Tsallis, aggiungendo un'intestazione ## Description e spiegando i simboli.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90