JuliaDynamics / ChaosTools.jl

Tools for the exploration of chaos and nonlinear dynamics
https://juliadynamics.github.io/DynamicalSystemsDocs.jl/chaostools/stable/
MIT License
186 stars 35 forks source link

fix typos #305

Closed spaette closed 1 year ago

spaette commented 1 year ago

https://github.com/JuliaDynamics/ChaosTools.jl/issues/304

CHANGELOG.md docs/src/periodicity.md src/chaosdetection/expansionentropy.jl src/chaosdetection/gali.jl src/chaosdetection/lyapunovs/local_growth_rates.jl src/chaosdetection/lyapunovs/lyapunov.jl src/chaosdetection/lyapunovs/lyapunov_from_data.jl src/chaosdetection/lyapunovs/lyapunovspectrum.jl src/chaosdetection/partially_predictable.jl src/chaosdetection/testchaos01.jl src/dimreduction/dyca.jl src/periodicity/yin.jl src/rareevents/mean_return_times/mrt_api.jl src/rareevents/mean_return_times/mrt_continuous.jl src/rareevents/mean_return_times/mrt_discrete.jl src/rareevents/mean_return_times/transit_times_statistics.jl test/dimreduction/dyca.jl src/stability/fixedpoints.jl test/dimreduction/dyca.jl test/rareevents/return_time_tests.jl

Datseris commented 1 year ago

great, this is good!

Datseris commented 1 year ago

you shouldnt change affect and effect because these are words from the DIffEq universe.

spaette commented 1 year ago

reverted the mistake changing docs/src/periodicity.md and followed up with a soft reset

unfortunately docs/src/periodicity.md currently shows up in the patch for the Draft PR

that might be interpreted as resulting in a git history which is not clean

the latest comment on the linked to Issue has a shell script with sed commands

an additional decision might be made on spelling as thresold

grep -nr thresold ChaosTools.jl

Should these lines be added to the shell script?

sed -i "s/thresold/threshold/g" ChaosTools.jl/src/dimreduction/dyca.jl
sed -i "s/thresold/threshold/g" ChaosTools.jl/test/dimreduction/dyca.jl

my preference would be to close this Draft PR and open a new PR for a clean git history

spaette commented 1 year ago

the DIffEq universe

possibly DiffEqBase.jl here

Datseris commented 1 year ago

Yes, thesold should also be corrected. Do not worry about opening a new PR. I am squashing anyways so the number of commits doesn't matter.

Datseris commented 1 year ago

possibly DiffEqBase.jl here

It's SciMLBase.

codecov-commenter commented 1 year ago

Codecov Report

Merging #305 (df6abca) into main (6c311a3) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #305   +/-   ##
=======================================
  Coverage   48.23%   48.23%           
=======================================
  Files          22       22           
  Lines         904      904           
=======================================
  Hits          436      436           
  Misses        468      468           
Impacted Files Coverage Δ
src/chaosdetection/expansionentropy.jl 86.04% <ø> (ø)
src/chaosdetection/gali.jl 86.04% <ø> (ø)
src/chaosdetection/lyapunovs/local_growth_rates.jl 100.00% <ø> (ø)
src/chaosdetection/lyapunovs/lyapunov.jl 98.00% <ø> (ø)
src/chaosdetection/lyapunovs/lyapunov_from_data.jl 83.33% <ø> (ø)
src/chaosdetection/lyapunovs/lyapunovspectrum.jl 87.23% <ø> (ø)
src/chaosdetection/partially_predictable.jl 0.00% <ø> (ø)
src/chaosdetection/testchaos01.jl 100.00% <ø> (ø)
src/dimreduction/dyca.jl 0.00% <ø> (ø)
src/periodicity/yin.jl 0.00% <ø> (ø)
... and 5 more

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

spaette commented 1 year ago

thesold corrected

errant newline removed (docs/src/periodicity.md no longer appears in patch)

when merged repo should have a git history which is clean

PR has one commit


SciMLBase

SciMLBase.jl

the following returns output

grep -nr affect_ SciMLBase.jl