Rename some keywords of `AttractorsViaRecurrences`

[Datseris]

Closes #104

This PR does the renaming of #104 and adds changelog entries.

[codecov-commenter]

Codecov Report

Merging #107 (10010c9) into main (b273166) will decrease coverage by 0.34%. The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #107      +/-   ##
==========================================
- Coverage   84.56%   84.22%   -0.34%     
==========================================
  Files          23       23              
  Lines        1192     1192              
==========================================
- Hits         1008     1004       -4     
- Misses        184      188       +4     

Files	Coverage Δ
src/mapping/attractor_mapping_proximity.jl	76.19% <100.00%> (ø)
...pping/recurrences/attractor_mapping_recurrences.jl	85.71% <ø> (ø)
src/mapping/recurrences/finite_state_machine.jl	91.47% <100.00%> (ø)

... and 1 file with indirect coverage changes

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

[awage]

I have no problem with the keywords changes. But is there a string doc in the code where we say that these keywords are equivalent to the old ones? It can be also a legacy basins_of_attraction function.

[Datseris]

No, this is said in the CHANGELOG. The docstrings are only meaningful for the current version of the code. They have no reason to refer to prior versions.

[Datseris]

@awage is it okay that this change is mentioned in the changelog?

[awage]

Ok, I understand. So it is deprecated but the keywords are still accepted until the next breaking release? In the changelog it should be clear that the keywords are still accepted until the next breaking version. Then we can forget about them.

[Datseris]

This is what "deprecated" means. Quite literally: "the names are still accepted until the next breaking release. They will be removed at the next breaking release. They are not mentioned anywhere in the documentation."

[theogf]

I might be wrong but it looks like the old kwargs are not accepted anymore?

[Datseris]

There should be. If not, it's a bug. Do you have a MWE? If yes, open an new issue!