Warn about and discourage the use of pickle to save objects by spjuhel · Pull Request #942 · CLIMADA-project/climada_python
Changes proposed in this PR:
- Warns and discourages users to use pickle for any long term saving in tutorial/documentation.
- Adds a short section in Best Practice explaining the cons of using pickle.
Climada offers the possibility to use pickle to save most objects. Yet, this format is dependent on the python environment used when saving any object and thus offer very limited portability.
This is tied to SCRUM task 149 and User Story 148 (Improve saving conventions for Climada objects)
PR Author Checklist
- Read the Contribution Guide
- Correct target branch selected (if unsure, select
develop) - Descriptive pull request title added
- Source branch up-to-date with target branch
- Documentation updated
- Tests updated
- Tests passing
- No new linter issues
- Changelog updated
PR Reviewer Checklist
- Read the Contribution Guide
- CLIMADA Reviewer Checklist passed
- Tests passing
- No new linter issues