From dc2ad775ae99120bc34e04a0923435406554d1ac Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <h.tomwoerden@indiscale.com>
Date: Mon, 14 Nov 2022 21:32:13 +0100
Subject: [PATCH] MAINT: minor documentation changes
---
README.md | 5 +++++
integrationtests/basic_example/test_basic.py | 4 ++--
src/doc/converters.rst | 2 +-
3 files changed, 8 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index b97fc877..109285ab 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,12 @@ After installation of the package run (within the project folder):
pytest
```
+There is the file `unittests/records.xml` that servers as a dummy for a server state with files.
+You can recreate this by uncommenting a section in `integrationtests/basic_example/test_basic.py`
+and rerunning the integration test.
+
## Integration Tests
+
see `integrationtests/README.md`
# Contributers
diff --git a/integrationtests/basic_example/test_basic.py b/integrationtests/basic_example/test_basic.py
index 4b8ec8f7..a4261cd9 100755
--- a/integrationtests/basic_example/test_basic.py
+++ b/integrationtests/basic_example/test_basic.py
@@ -114,8 +114,8 @@ def test_single_insertion(clear_database, usemodel, crawler, ident):
for i in reversed(range(len(res))):
if res[i].parents[0].name == "PyTestInfo":
del res[i]
- filename = rfp("..", "..", "unittests", "records.xml")
- # TODO can we remove this? why should we overwrite the current xml
+ # uncomment this to recreate the `records.xml` file
+ # filename = rfp("..", "..", "unittests", "records.xml")
# with open(filename, "w") as f:
# xml = res.to_xml()
# # Remove noscript and transaction benchmark:
diff --git a/src/doc/converters.rst b/src/doc/converters.rst
index 610689fe..1839d59d 100644
--- a/src/doc/converters.rst
+++ b/src/doc/converters.rst
@@ -69,7 +69,7 @@ directory name using the 'match' key.
Simple File Converter
=====================
The Simple File Converter does not create any children and is usually used if
-A file shall be used as it is and be inserted and referenced by other entities.
+a file shall be used as it is and be inserted and referenced by other entities.
Markdown File Converter
=======================
--
GitLab