JuliaDynamics/ComplexityMeasures.jl

Consistent formatting for `InformationMeasure`s

Ouverte

#303 ouverte le 25 août 2023

Voir sur GitHubGuide contributeur
 (1 commentaire) (1 réaction) (0 personne assignée)Julia (19 forks)auto 404
documentationgood first issue

Métriques du dépôt

Stars
 (79 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Identifiez les définitions de mesures d'information avec un formatage incohérent et mettez à jour leurs docstrings pour suivre le style utilisé par les entropies de Renyi et Tsallis, en ajoutant un en tête ## Description et en expliquant les symboles.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90