Skip to content

Make helpers examples runnable #2483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Mar 26, 2024
Merged

Make helpers examples runnable #2483

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
8058861
Update quickstart.rst
iuliaferoli Jan 18, 2024
dc66553
Update quickstart.rst
iuliaferoli Feb 8, 2024
9fd57de
added changes based on Quentin's comments
iuliaferoli Feb 9, 2024
ee1dd75
formatting and
iuliaferoli Feb 9, 2024
f89871a
adding examples of how to import the helpers;
iuliaferoli Mar 22, 2024
5ac53b5
Merge branch 'elastic:main' into iuliaferoli-docs-quickstart-update
iuliaferoli Mar 22, 2024
d4a0564
Merge branch 'elastic:main' into iuliaferoli-docs-quickstart-update
iuliaferoli Mar 26, 2024
86fcbf7
removed the unused helpers import
iuliaferoli Mar 26, 2024
bf24911
Merge branch 'iuliaferoli-docs-quickstart-update' of https://github.c…
iuliaferoli Mar 26, 2024
3145d72
Update docs/sphinx/helpers.rst
iuliaferoli Mar 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/sphinx/helpers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@ Helpers

Collection of simple helper functions that abstract some specifics of the raw API.

Connecting
----------

.. code-block:: python

from elasticsearch import Elasticsearch

client = Elasticsearch("https://.../", api_key="YOUR_API_KEY")


Bulk helpers
------------
Expand Down