Updating docs (#43)

* Short length

* Fatal errors (prefix: F)

* Errors (prefix: E)

* Warnings (prefix: W)

* Update constants.py

* Update constants.py

* update

* update docs

* example

* update

* YY

* revisions: docs/linters

---------

Co-authored-by: Laureen Thurner <130306776+LaureenTh@users.noreply.github.com>

Author: geritwagner

docs/source/dev_docs/_autosummary/search_query.linter.rst

@@ -13,5 +13,6 @@ search\_query.linter
 
    .. autosummary::
 
-      get_parser
+      lint_file
+      lint_query_string
       pre_commit_hook

docs/source/lint/E0001.rst

@@ -9,6 +9,18 @@ E0001 — search-field-missing
 
 **Scope**: all
 
-**Description**: Expected search field is missing
+**Problematic query**:
+
+.. code-block:: text
+
+    # PLATFORM.PUBMED:
+    "eHealth" OR "digital health"
+
+**Recommended query**:
+
+.. code-block:: text
+
+    # PLATFORM.PUBMED:
+    "eHealth"[all] OR "digital health"[all]
 
 **Back to**: :ref:`lint`

docs/source/lint/E0002.rst

@@ -9,6 +9,22 @@ E0002 — search-field-contradiction
 
 **Scope**: all
 
-**Description**: Contradictory search fields specified
+**Problematic query**:
+
+.. code-block:: text
+
+    # PLATFORM.WOS:
+    # Search with general search field = "ALL FIELDS"
+    TI=(digital AND online)
+
+**Recommended query**:
+
+.. code-block:: text
+
+    # PLATFORM.WOS:
+    # Search without general search field
+    TI=(digital AND online)
+
+**Typical fix**: Ensure that the search fields used in the query and the general search field parameter are consistent.
 
 **Back to**: :ref:`lint`

docs/source/lint/E0004.rst

@@ -9,6 +9,18 @@ E0004 — invalid-character
 
 **Scope**: PLATFORM.PUBMED
 
-**Description**: Search term contains invalid character
+**Problematic query**:
+
+.. code-block:: text
+
+    # PLATFORM.WOS
+    "@digital-native"[ti]
+
+**Recommended query**:
+
+.. code-block:: text
+
+    # PLATFORM.WOS
+    "digital-native"[ti]
 
 **Back to**: :ref:`lint`

docs/source/lint/E0005.rst

@@ -9,6 +9,18 @@ E0005 — invalid-proximity-use
 
 **Scope**: PLATFORM.PUBMED, PLATFORM.EBSCO
 
-**Description**: Invalid use of the proximity operator
+Proximity operators must have a non-negative integer as the distance.
+
+**Problematic query**:
+
+.. code-block:: text
+
+    "digital health"[tiab:~0.5]
+
+**Recommended query**:
+
+.. code-block:: text
+
+    "digital health"[tiab:5]
 
 **Back to**: :ref:`lint`

docs/source/lint/E0006.rst

@@ -9,6 +9,18 @@ E0006 — invalid-wildcard-use
 
 **Scope**: PLATFORM.PUBMED
 
-**Description**: Invalid use of the wildcard operator *
+**Problematic query**:
+
+.. code-block:: text
+
+    "health tracking" AND AI*
+
+**Recommended query**:
+
+.. code-block:: text
+
+    "health tracking" AND AID*
+
+**Typical fix**: Avoid using wildcards (*) with short strings (less than 4 characters). Specify search fields directly in the query instead of relying on general search field settings.
 
 **Back to**: :ref:`lint`

docs/source/lint/E0007.rst

@@ -7,8 +7,20 @@ E0007 — query-starts-with-platform-identifier
 
 **Message**: ``Query starts with platform identifier``
 
-**Scope**: PLATFORM.WOS
+**Scope**: all
 
-**Description**: Query starts with platform identifier
+**Problematic query**:
+
+.. code-block:: text
+
+    # PLATFORM.WOS
+    WOS: eHealth[ti]
+
+**Recommended query**:
+
+.. code-block:: text
+
+    # PLATFORM.WOS
+    eHealth[ti]
 
 **Back to**: :ref:`lint`

docs/source/lint/E0008.rst

@@ -7,8 +7,20 @@ E0008 — query-in-quotes
 
 **Message**: ``The whole Search string is in quotes.``
 
-**Scope**: PLATFORM.WOS
+**Scope**: all
 
-**Description**: The whole Search string is in quotes.
+**Problematic query**:
+
+.. code-block:: text
+
+    # PLATFORM.WOS
+    "eHealth[ti] AND digital health[ti]"
+
+**Recommended query**:
+
+.. code-block:: text
+
+    # PLATFORM.WOS
+    eHealth[ti] AND digital health[ti]
 
 **Back to**: :ref:`lint`

docs/source/lint/F0001.rst

@@ -9,6 +9,6 @@ F0001 — tokenizing-failed
 
 **Scope**: all
 
-**Description**: Fatal error during tokenization
+**Typical fix**: Check the query syntax and ensure it is correctly formatted.
 
 **Back to**: :ref:`lint`

docs/source/lint/F1001.rst

@@ -9,18 +9,18 @@ F1001 — unbalanced-parentheses
 
 **Scope**: all
 
-**Typical fix**: Check the parentheses in the query
-
 **Problematic query**:
 
-.. code-block:: python
+.. code-block:: text
 
     (a AND b OR c
 
-**Correct query**:
+**Recommended query**:
 
-.. code-block:: python
+.. code-block:: text
 
     (a AND b) OR c
 
+**Typical fix**: Check the parentheses in the query
+
 **Back to**: :ref:`lint`