Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Consistent formatting for InformationMeasures #303

Open
kahaaga opened this issue Aug 25, 2023 · 1 comment
Open

Consistent formatting for InformationMeasures #303

kahaaga opened this issue Aug 25, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@kahaaga
Copy link
Member

kahaaga commented Aug 25, 2023 •
edited

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.
@kahaaga kahaaga added documentation Improvements or additions to documentation enhancement New feature or request that is non-breaking labels Aug 25, 2023
@Datseris Datseris added good first issue Good for newcomers and removed enhancement New feature or request that is non-breaking labels Aug 25, 2023
@Datseris
Copy link
Member

(I've removed the "enhancement" label, as this label is for enhancements to the exported API)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kahaaga @Datseris