summaryrefslogtreecommitdiff
path: root/redis/commands
diff options
context:
space:
mode:
authorChayim <chayim@users.noreply.github.com>2021-12-30 12:52:11 +0200
committerGitHub <noreply@github.com>2021-12-30 12:52:11 +0200
commitbc3dbb45d7236f96d614c33684a94f3e0fd9ac4a (patch)
tree5da61d39c34e3ad558be7c78c9f54c185084968e /redis/commands
parentdeaaa536568e50b6ce958de0dd6306392e98f13e (diff)
downloadredis-py-bc3dbb45d7236f96d614c33684a94f3e0fd9ac4a.tar.gz
Documentation cleanup (#1841)
Diffstat (limited to 'redis/commands')
-rw-r--r--redis/commands/graph/commands.py2
-rw-r--r--redis/commands/search/commands.py46
2 files changed, 20 insertions, 28 deletions
diff --git a/redis/commands/graph/commands.py b/redis/commands/graph/commands.py
index e097936..1db8275 100644
--- a/redis/commands/graph/commands.py
+++ b/redis/commands/graph/commands.py
@@ -35,7 +35,6 @@ class GraphCommands:
Args:
- -------
q :
The query.
params : dict
@@ -127,7 +126,6 @@ class GraphCommands:
Args:
- -------
query:
The query that will be executed.
params: dict
diff --git a/redis/commands/search/commands.py b/redis/commands/search/commands.py
index 4ec6fc9..d22afeb 100644
--- a/redis/commands/search/commands.py
+++ b/redis/commands/search/commands.py
@@ -73,12 +73,9 @@ class SearchCommands:
### Parameters:
- **fields**: a list of TextField or NumericField objects
- - **no_term_offsets**: If true, we will not save term offsets in
- the index
- - **no_field_flags**: If true, we will not save field flags that
- allow searching in specific fields
- - **stopwords**: If not None, we create the index with this custom
- stopword list. The list can be empty
+ - **no_term_offsets**: If true, we will not save term offsets in the index
+ - **no_field_flags**: If true, we will not save field flags that allow searching in specific fields
+ - **stopwords**: If not None, we create the index with this custom stopword list. The list can be empty
For more information: https://oss.redis.com/redisearch/Commands/#ftcreate
""" # noqa
@@ -132,6 +129,7 @@ class SearchCommands:
### Parameters:
- **delete_documents**: If `True`, all documents will be deleted.
+
For more information: https://oss.redis.com/redisearch/Commands/#ftdropindex
""" # noqa
keep_str = "" if delete_documents else "KEEPDOCS"
@@ -219,27 +217,23 @@ class SearchCommands:
### Parameters
- **doc_id**: the id of the saved document.
- - **nosave**: if set to true, we just index the document, and don't
- save a copy of it. This means that searches will just
- return ids.
- - **score**: the document ranking, between 0.0 and 1.0
- - **payload**: optional inner-index payload we can save for fast
- i access in scoring functions
- - **replace**: if True, and the document already is in the index,
+ - **nosave**: if set to true, we just index the document, and don't \
+ save a copy of it. This means that searches will just return ids.
+ - **score**: the document ranking, between 0.0 and 1.0.
+ - **payload**: optional inner-index payload we can save for fast access in scoring functions
+ - **replace**: if True, and the document already is in the index, \
we perform an update and reindex the document
- - **partial**: if True, the fields specified will be added to the
- existing document.
- This has the added benefit that any fields specified
- with `no_index`
- will not be reindexed again. Implies `replace`
+ - **partial**: if True, the fields specified will be added to the \
+ existing document. \
+ This has the added benefit that any fields specified \
+ with `no_index` will not be reindexed again. Implies `replace`
- **language**: Specify the language used for document tokenization.
- - **no_create**: if True, the document is only updated and reindexed
- if it already exists.
- If the document does not exist, an error will be
- returned. Implies `replace`
- - **fields** kwargs dictionary of the document fields to be saved
- and/or indexed.
- NOTE: Geo points shoule be encoded as strings of "lon,lat"
+ - **no_create**: if True, the document is only updated and reindexed \
+ if it already exists. If the document does not exist, an error will be \
+ returned. Implies `replace`
+ - **fields** kwargs dictionary of the document fields to be saved and/or indexed.
+
+ NOTE: Geo points shoule be encoded as strings of "lon,lat"
For more information: https://oss.redis.com/redisearch/Commands/#ftadd
""" # noqa
@@ -487,7 +481,7 @@ class SearchCommands:
**query**: search query.
**distance***: the maximal Levenshtein distance for spelling
- suggestions (default: 1, max: 4).
+ suggestions (default: 1, max: 4).
**include**: specifies an inclusion custom dictionary.
**exclude**: specifies an exclusion custom dictionary.