diff --git a/CHANGELOG.md b/CHANGELOG.md index b6af052328faf157410d4bb28dcd11383159c0b0..8ae01a67a54f08bed91c978457d00ca51ad54789 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,8 +13,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed ### -- There are no DictXYElements any more. For example, DictTextElement is now - simply a TextElement. The behavior of the following classes changed: +- The DictXYElements are now depricated. For example, instead of + DictTextElement you should use simply a TextElement. See READ + See The behavior of the following classes changed: - DictElementConverter (old: DictConverter) now can use "match" keywords. If none are in the definition, the behavior is as before. - TextElement used the 'match' keyword before, which was applied to the diff --git a/src/doc/README_SETUP.md b/src/doc/README_SETUP.md index d63f2da16659f64a0c40ab849f473ec7a3436f7e..1f6e15d408e10e38bce0d9b9fe9b6197ec69bfc3 100644 --- a/src/doc/README_SETUP.md +++ b/src/doc/README_SETUP.md @@ -56,13 +56,6 @@ pip3 install --user . **Note**: In the near future, this package will also be made available on PyPi. -## Configuration ## - - - -## Try it out ## - - ## Run Unit Tests diff --git a/src/doc/how-to-upgrade.md b/src/doc/how-to-upgrade.md new file mode 100644 index 0000000000000000000000000000000000000000..5bff180001155a4205a830505bf5f296af877162 --- /dev/null +++ b/src/doc/how-to-upgrade.md @@ -0,0 +1,11 @@ + +# How to upgrade + +## 0.2.x to 0.3.0 +If you had "match", "match_name" or "match_value" in the definition of a +DictConverter (StructureElement: Dict) before, +you probably want to remove those. They were ignored before and are now used. + +If you used the 'match' keyword in the definition of TextElementConverter +(StructureElement: TextElement) before, you need to change the key from "match" +to "match_name" in order to preserve the behavior. diff --git a/src/doc/index.rst b/src/doc/index.rst index 3f55ae51990cf7f8a958e7c1ba5c7e4836ca3ae3..b4e30e4728068cabb92626cfac986ab858a0bbb6 100644 --- a/src/doc/index.rst +++ b/src/doc/index.rst @@ -13,6 +13,7 @@ CaosDB-Crawler Documentation CFoods (Crawler Definitions)<cfood> Macros<macros> Tutorials<tutorials/index> + How to upgrade<how-to-upgrade> API documentation<_apidoc/modules> @@ -40,5 +41,3 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` - -