Skip to content

Commit

Permalink
Improve docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
hannes-ucsc committed Oct 25, 2024
1 parent 90a037f commit 0949201
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion src/azul/indexer/document.py
Original file line number Diff line number Diff line change
Expand Up @@ -1321,12 +1321,16 @@ def to_index(self,
field_types: CataloguedFieldTypes
) -> JSON:
"""
Build request parameters from the document for indexing
Prepare a request to write this document to the index. The return value
is a dictionary with keyword arguments to the ES client method selected
by the :meth:`op_type` property.
:param catalog: An optional catalog name. If None, this document's
coordinates must supply it. Otherwise this document's
coordinates must supply the same catalog or none at all.
:param field_types: A mapping of field paths to field type
:return: Request parameters for indexing
"""
op_type = self.op_type
Expand Down

0 comments on commit 0949201

Please sign in to comment.