diff --git a/docs/compatibility.md b/docs/compatibility.md index 9ad8ae73a89..705cb1e8a06 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -60,13 +60,22 @@ version of) `pymatgen`. ## Minimum Python Version As a rule of thumb, `pymatgen` will support whatever versions of Python the latest -version of numpy supports (at the time of writing, this is Python 3.8+). You can +version of `numpy` supports (at the time of writing, this is Python 3.8+). You can also check what versions of Python are being tested automatically as part of our continuous integration testing on GitHub. We currently test `pymatgen` on Mac, Windows and Linux. ## Recent Breaking Changes +## v2024.1.26 + +The mixture of `(get|from)_str` and `(get|from)_string` methods on various `pymatgen` classes were migrated to a consistent `(get|from)_str` everywhere in [#3158](https://github.com/materialsproject/pymatgen/pull/3158) and several follow-up PRs. The deprecation release was [v2023.8.10](https://github.com/materialsproject/pymatgen/releases/tag/v2023.8.10) and the removal release resulting in a breaking change was [v2024.1.26](https://github.com/materialsproject/pymatgen/releases/tag/v2024.1.26). Migration to the new API in all cases is to replace: + +```diff +- (to|from|as|get)_string ++ (to|from|as|get)_str +``` + ### v2023.7.11 Rename `[SomeCode]ParserError` to `[SomeCode]ParseError` and inherit from `SyntaxError`. [#3140](https://github.com/materialsproject/pymatgen/pull/3140)