JuliaDynamics/ComplexityMeasures.jl

Consistent formatting for `InformationMeasure`s

Open

#303 opened on Aug 25, 2023

View on GitHubContributor guide
 (1 comment) (1 reaction) (0 assignees)Julia (19 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (79 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Identify the information measure definitions with inconsistent formatting and update their docstrings to follow the style used by Renyi and Tsallis entropies, adding a ## Description header and explaining symbols.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90