zhangyiss/toml11
1
0
Fork 0
mirror of https://github.com/ToruNiina/toml11.git synced 2025-09-16 16:28:09 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: add info about breaking changes to README

Browse Source
This commit is contained in:
ToruNiina
2019-06-20 14:57:54 +09:00
parent c3922c0d51
commit a0d74a5542
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -1376,15 +1376,18 @@ Between v2 and v3, those interfaces are rearranged.
- Supports for the CamelCaseNames are dropped.
- See [Underlying types](#underlying-types) for detail.
- `(is|as)_float` has been removed to make the function names consistent with others.
Since `float` is a keyword, toml11 named a float type as `toml::floating`.
Also a `value_t` corresponds to `toml::floating` is named `value_t::floating`.
So `(is|as)_floating` is introduced and `is_float` has been removed.
- Since `float` is a keyword, toml11 named a float type as `toml::floating`.
- Also a `value_t` corresponds to `toml::floating` is named `value_t::floating`.
- So `(is|as)_floating` is introduced and `is_float` has been removed.
- See [Casting a toml::value](#casting-a-tomlvalue) and [Checking value type](#checking-value-type) for detail.
- `toml::find` for `toml::table` has been dropped. Use `toml::value` version instead.
- An overload of `toml::find` for `toml::table` has been dropped. Use `toml::value` version instead.
- Because type conversion between a table and a value causes ambiguity while overload resolution
- Also because `toml::table` is a normal STL container, implementing utility function is easy.
- See [Finding a toml::value](#finding-a-tomlvalue) for detail.
- Interface around comments.
- See [Preserving Comments](#preserving-comments) for detail.
- An old `from_toml` has been removed
- An ancient `from_toml/into_toml` has been removed. Use arbitrary type conversion support.
- See [Conversion between toml value and arbitrary types](#conversion-between-toml-value-and-arbitrary-types) for detail.
Such a big change will not happen in the coming years.