F escape

Summary

function for escaping characters

Focus

Test Environment

unittest

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues https://gitlab.indiscale.com/caosdb/customers/dimr/management/-/issues/139
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

src/linkahead/utils/escape.py

@@ -21,10 +21,11 @@
 
 
 def escape_quoted_text(text: str) -> str:
-    """The characters `\` and `*` need to be escaped if used in quoted expressions in the query
+    """The characters ``\\`` and ``*`` need to be escaped if used in quoted expressions in the query
     language.
 
-    This function return the given string where the characters `\` and `*` are escaped by a `\`.
+    This function return the given string where the characters ``\\`` and ``*`` are escaped by
+    a ``\\``.
 
     Parameters
     ----------