search

JuliaDynamics / ComplexityMeasures.jl

Estimators for probabilities, entropies, and other complexity measures derived from data in the context of nonlinear dynamics and complex systems
MIT License
48 stars 11 forks source link

Finish changelog for v3 #361

Closed Datseris closed 6 months ago

Datseris commented 6 months ago

Closes #357

@kahaaga I think there are some things missing here... We should have a look carefully.

I removed the section on bugfixes as the changelog will already be long and I think mentioning bugfixes isn't crucial information.

codecov[bot] commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (27c0f6b) 89.07% compared to head (8db91de) 89.07%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #361 +/- ## ======================================= Coverage 89.07% 89.07% ======================================= Files 79 79 Lines 2224 2224 ======================================= Hits 1981 1981 Misses 243 243 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

kahaaga commented 6 months ago

I've compared the stable and dev doc branches and ensured that most major new functionality is mentioned.

Crucially, we didn't mention that what were previously ProbabilitiesEstimators are now OutcomeSpaces instead, and that ProbabilitiesEstimators now have a different role. I also added some missing new features.

The change log is long, but that is okay: it summarizes more than half a year of active development effort.

As for the bug fixes, I vote for keeping them in there. We've painstakingly kept a log of such changes for all previous versions, which is a practice I think we should continue. In particular, some of these bug fixes are in response to issues people have opened, so they should be able to find out why their code behaves differently after upgrading to v3.0. The changelog is not shown anywhere in the online docs anyways, so it being a bit long won't bother anyone, except for people that are super-interested in details and seek out the markdown file in the repo on Github.

If you're okay with it, I'll re-introduce the bug fixes, merge and tag a new version.

Datseris commented 6 months ago

Okay, you can in re-introduce the bugfixes and tag a new version! I'll prepare an announcement post!

kahaaga commented 6 months ago

Okay, you can in re-introduce the bugfixes and tag a new version! I'll prepare an announcement post!

Excellent!

kahaaga commented 6 months ago

Okay, you can in re-introduce the bugfixes and tag a new version! I'll prepare an announcement post!

Let me know if you want some input on the announcement before you post it!