Skip to content

Commit 02df065

Browse files
feat: extend documentation for "improve", make example self-contained (#60)
* add introduction to tranlate function * add introduction to "improve-function" documentation * extend "improve function" docs * fix typo * revert changes to translate docs * make example self-contained
1 parent 5111294 commit 02df065

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

docs/source/improve.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Improve
44
==========================================================
55

6+
The improve functionality of search-query depicts the query refinement step of a literature search.
7+
This includes modification of the query.
8+
The search space can be expanded to include plural forms and spelling variants by including wildcard operators and nested OR queries, as shown in the following examples.
9+
610
Modification
711
---------------------
812

docs/source/save.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ To write a query to a JSON file, run the serializer:
88
.. code-block:: python
99
1010
from search_query import SearchFile
11+
from search_query.and_query import AndQuery
12+
13+
query = AndQuery(["digital", "work"], field="title")
1114
1215
search_file = SearchFile(
1316
filename="search-file.json",

0 commit comments

Comments
 (0)