Skip to content

Commit 790e1a0

Browse files
committed
Docs: Resolve "bullet list ends without a blank line" warning
1 parent d0cc0ce commit 790e1a0

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

redis/commands/search/commands.py

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -337,30 +337,30 @@ def add_document(
337337
"""
338338
Add a single document to the index.
339339
340-
### Parameters
340+
Args:
341341
342-
- **doc_id**: the id of the saved document.
343-
- **nosave**: if set to true, we just index the document, and don't
342+
doc_id: the id of the saved document.
343+
nosave: if set to true, we just index the document, and don't
344344
save a copy of it. This means that searches will just
345345
return ids.
346-
- **score**: the document ranking, between 0.0 and 1.0
347-
- **payload**: optional inner-index payload we can save for fast
348-
i access in scoring functions
349-
- **replace**: if True, and the document already is in the index,
350-
we perform an update and reindex the document
351-
- **partial**: if True, the fields specified will be added to the
346+
score: the document ranking, between 0.0 and 1.0
347+
payload: optional inner-index payload we can save for fast
348+
access in scoring functions
349+
replace: if True, and the document already is in the index,
350+
we perform an update and reindex the document
351+
partial: if True, the fields specified will be added to the
352352
existing document.
353353
This has the added benefit that any fields specified
354354
with `no_index`
355355
will not be reindexed again. Implies `replace`
356-
- **language**: Specify the language used for document tokenization.
357-
- **no_create**: if True, the document is only updated and reindexed
356+
language: Specify the language used for document tokenization.
357+
no_create: if True, the document is only updated and reindexed
358358
if it already exists.
359359
If the document does not exist, an error will be
360360
returned. Implies `replace`
361-
- **fields** kwargs dictionary of the document fields to be saved
362-
and/or indexed.
363-
NOTE: Geo points shoule be encoded as strings of "lon,lat"
361+
fields: kwargs dictionary of the document fields to be saved
362+
and/or indexed.
363+
NOTE: Geo points shoule be encoded as strings of "lon,lat"
364364
""" # noqa
365365
return self._add_document(
366366
doc_id,

0 commit comments

Comments
 (0)