From 6052b00ae6dda6db87433d51c200498fd8a65160 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <h.tomwoerden@indiscale.com>
Date: Mon, 21 Nov 2022 16:05:58 +0100
Subject: [PATCH] DOC: add info on how to update
---
CHANGELOG.md | 5 +++--
src/doc/README_SETUP.md | 7 -------
src/doc/how-to-upgrade.md | 11 +++++++++++
src/doc/index.rst | 3 +--
4 files changed, 15 insertions(+), 11 deletions(-)
create mode 100644 src/doc/how-to-upgrade.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
index b6af0523..8ae01a67 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 d63f2da1..1f6e15d4 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 00000000..5bff1800
--- /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 3f55ae51..b4e30e47 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`
-
-
--
GitLab