JuliaDynamics/ComplexityMeasures.jl

Consistent formatting for `InformationMeasure`s

Offen

#303 geöffnet am 25.08.2023

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (1 Reaktion) (0 zugewiesene Personen)Julia (19 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (79 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Identifizieren Sie die Definitionen von Informationsmaßen mit inkonsistenter Formatierung und aktualisieren Sie ihre Docstrings, um dem von Renyi und Tsallis Entropien verwendeten Stil zu folgen, indem Sie eine ## Description Überschrift hinzufügen und Symbole erklären.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90