@@ -337,30 +337,30 @@ def add_document(
337
337
"""
338
338
Add a single document to the index.
339
339
340
- ### Parameters
340
+ Args:
341
341
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
344
344
save a copy of it. This means that searches will just
345
345
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
352
352
existing document.
353
353
This has the added benefit that any fields specified
354
354
with `no_index`
355
355
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
358
358
if it already exists.
359
359
If the document does not exist, an error will be
360
360
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"
364
364
""" # noqa
365
365
return self ._add_document (
366
366
doc_id ,
0 commit comments