docs: add documentation for backward compatibilities

42atomys commented 2 months ago

Description

Few variables and methods don't have the mention for backward compatibility only. Also two changes of sprout has not clearly identified in the temporary list in SPRIG_TO_SPROUT_CHANGES_NOTES.md file.

Changes

Add documentation line on backward functions
Add changes on the SPRIG_TO_SPROUT_CHANGES_NOTES.md file

Fixes #39 #40

Checklist

[x] I have read the CONTRIBUTING.md document.
[x] My code follows the code style of this project.
[x] I have added tests to cover my changes.
[x] All new and existing tests passed.
[x] I have updated the documentation accordingly.
[x] This change requires a change to the documentation on the website.

Additional Information

_The file SPRIG_TO_SPROUT_CHANGES_NOTES.md will be moved in the future on the documentation site_

andig commented 2 months ago

Having looked at the PR: what is the recommended function for the FuncMap that does not rely on global state and still contains most (all?) of the sprig functions? Sorry if this appears stupid- I have honestly lost track.

In other words: if all sprout funcmap functions now contain the BACKWARDS COMPATIBILITY ONLY warning- how do I get a "proper" sprout funcmap (i.e. one I would use if I didn't come from sprig) and what are the differences to the old one?

42atomys commented 2 months ago

Hi @andig, firstly, no question are stupid !

Currently no "proper" exist, and this is discussed before implementation in the RFC: Loader and others RFCs as well.

I want to not rush the v1.0 and create a solid foundation with the feedback of everyone 💜

andig commented 2 months ago

I‘m still confused, as to which functions are currently integrated in which funcmap. Is it correct to assume that- for time being- funcmaps contain all functions, including sprig legacy ones?

go-sprout / sprout