update docs

Author: Gerit Wagner

docs/source/cli.rst

@@ -10,23 +10,23 @@ To translate a search query on the command line, run
 
 .. code-block:: bash
 
-    search-query-translate --from colrev_web_of_science \
+    search-query-translate --from wos \
                             --input input_query.txt \
-                            --to colrev_pubmed \
+                            --to pubmed \
                             --output output_query.txt
 
 **Arguments**
 
 - ``--from`` (required):
   The source query format.
-  Example: ``colrev_web_of_science``
+  Example: ``wos``
 
 - ``--input`` (required):
   Path to the input file containing the original query.
 
 - ``--to`` (required):
   The target query format.
-  Example: ``colrev_pubmed``
+  Example: ``pubmed``
 
 - ``--output`` (required):
   Path to the file where the converted query will be written.
@@ -38,9 +38,9 @@ Suppose you have a Web of Science search query saved in ``input_query.txt`` and
 
 .. code-block:: bash
 
-    search-query-translate --from colrev_web_of_science \
+    search-query-translate --from wos \
                             --input input_query.txt \
-                            --to colrev_pubmed \
+                            --to pubmed \
                             --output output_query.txt
 
 The converted query will be saved in ``output_query.txt``.

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

@@ -27,5 +27,6 @@ search\_query.constants
       Operators
       PLATFORM
       QueryErrorCode
+      SearchField
       Token
       TokenTypes

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

@@ -18,5 +18,3 @@ search\_query.query
    .. autosummary::
 
       Query
-      SearchField
-      Term

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

@@ -0,0 +1,20 @@
+search\_query.query\_range
+==========================
+
+.. automodule:: search_query.query_range
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      RangeQuery

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

@@ -0,0 +1,20 @@
+search\_query.query\_term
+=========================
+
+.. automodule:: search_query.query_term
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Term

docs/source/dev_docs/_autosummary/search_query.rst

@@ -44,6 +44,8 @@
    search_query.query_near
    search_query.query_not
    search_query.query_or
+   search_query.query_range
+   search_query.query_term
    search_query.search_file
    search_query.serializer_base
    search_query.serializer_structured

docs/source/dev_docs/parser_development.rst

@@ -77,16 +77,13 @@ Implement ``parse_query_tree()`` to build the query object, creating nested quer
 
     Parsers can be developed as top-down parsers (see PubMed) or bottom-up parsers (see Web of Science).
 
-    For NOT operators, it is recommended to parse them as an AND query with negated children, e.g., ``A NOR B`` should be parsed as:
+    For NOT operators, it is recommended to parse them as a query with two children. The second child is the negated part (i.e., the operator is interpreted as ``AND NOT``). For example, ``A NOT B`` should be parsed as:
 
     .. code-block:: python
 
-        AND[
-            A,
-            NOT[B]
-        ]
+        NOT[A, B]
 
-Check whether ``SearchFields`` can be created for nested queries (e.g., ``TI=(eHealth OR mHealth)``or only for individual terms, e.g., ``eHealth[ti] OR mHealth[ti]``.)
+Check whether ``SearchFields`` can be created for nested queries (e.g., ``TI=(eHealth OR mHealth)`` or only for individual terms, e.g., ``eHealth[ti] OR mHealth[ti]``.)
 
 **Parser Skeleton**
 

docs/source/dev_docs/tests.rst

@@ -104,22 +104,22 @@ Test Types
 
 3. **Translation Tests**
     - Purpose: Confirm that parsing + serialization results in the expected generic or structured query string.
-    - Example:
-
-      **TODO:**
-
-      ::
 
-        @pytest.mark.parametrize(
-            "query_string, expected_translation",
-            [
-                ("TS=(eHealth) AND TS=(Review)", "AND[eHealth[TS=], Review[TS=]]"),
-            ],
-        )
-        def test_parser_translation(query_string, expected_translation):
-            parser = XYParser(query_string)
-            query_tree = parser.parse()
-            assert query_tree.to_generic_string() == expected_translation
+Example:
+
+.. code-block:: python
+
+   @pytest.mark.parametrize(
+      "query_string, expected_translation",
+      [
+            ("TS=(eHealth) AND TS=(Review)",
+            "AND[eHealth[TS=], Review[TS=]]"),
+      ],
+   )
+   def test_parser_translation(query_string, expected_translation):
+      parser = XYParser(query_string)
+      query_tree = parser.parse()
+      assert query_tree.to_generic_string() == expected_translation
 
 
 .. note::

docs/source/improve.rst

@@ -44,9 +44,9 @@ Modification
 
 
    query = AndQuery([
-      OrQuery(["labour", "employment"], search_field="ti"),
-      OrQuery(["robot", "algorith"], search_field="ti")
-   ], search_field="ti")
+      OrQuery(["labour", "employment"], search_field="title"),
+      OrQuery(["robot", "algorith"], search_field="title")
+   ], search_field="title")
 
    expand_spelling_variants(query)
    add_plural_wildcards(query)
@@ -82,9 +82,9 @@ See Cooper et al. 2018
    }
 
    query = AndQuery([
-      OrQuery(["microsourcing"], search_field="ti"),
-      OrQuery(["online"], search_field="ti")
-   ], search_field="ti")
+      OrQuery(["microsourcing"], search_field="title"),
+      OrQuery(["online"], search_field="title")
+   ], search_field="title")
 
    # Evaluate the search
    results = query.evaluate(records_dict)

docs/source/index.rst

@@ -47,8 +47,8 @@ Creating a query programmatically is simple:
     from search_query import OrQuery, AndQuery
 
     # Typical building-blocks approach
-    digital_synonyms = OrQuery(["digital", "virtual", "online"], search_field="ab")
-    work_synonyms = OrQuery(["work", "labor", "service"], search_field="ab")
+    digital_synonyms = OrQuery(["digital", "virtual", "online"], search_field="abstract")
+    work_synonyms = OrQuery(["work", "labor", "service"], search_field="abstract")
     query = AndQuery([digital_synonyms, work_synonyms])
 
 ..