Skip to content

Commit

Permalink
fix examples.asciidoc to match implementation
Browse files Browse the repository at this point in the history
Documentation mentions wrong / outdated keyword arguments when compared to the code implementation. These fixes correct the documentation to match the implementation.

Closes #2251
  • Loading branch information
mattiassluis committed Jul 7, 2023
1 parent ccca348 commit 43ce85e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/guide/examples.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ the Python client.
=== Indexing a document

To index a document, you need to specify three pieces of information: `index`,
`id`, and a `body`:
`id`, and a `document`:

[source,py]
----------------------------
Expand Down Expand Up @@ -79,7 +79,7 @@ for hit in resp['hits']['hits']:
=== Updating a document

To update a document, you need to specify three pieces of information: `index`,
`id`, and a `body`:
`id`, and a `doc`:

[source,py]
----------------------------
Expand All @@ -93,7 +93,7 @@ doc = {
'text': 'Interensting modified content...',
'timestamp': datetime.now(),
}
resp = client.update(index="test-index", id=1, document=doc)
resp = client.update(index="test-index", id=1, doc=doc)
print(resp['result'])
----------------------------

Expand All @@ -108,4 +108,4 @@ method:
[source,py]
----------------------------
client.delete(index="test-index", id=1)
----------------------------
----------------------------

0 comments on commit 43ce85e

Please sign in to comment.