Skip to content

Fix header symbols in the Index documentation page #34

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
sergio-bobillier merged 1 commit into from
Aug 18, 2025
Merged

Fix header symbols in the Index documentation page #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions documentation/source/user_guidelines/elasticsearch/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ which define connection re-try behaviour:
``wait_strategy``.

#push
*****
-----

The ``push`` method stores a document in the ``Index``'s buffer. If the buffer
reaches the maximum number of records the buffer will be flushed automatically.
Expand All @@ -76,7 +76,7 @@ Example:
index.flush # Do not forget to flush the index at the end.

#index
******
------

``index`` pushes a document directly to the Elasticsearch cluster without adding
it to the buffer first. So you don't need to call ``flush``:
Expand All @@ -98,7 +98,7 @@ Example:
.. _`Index#search`:

#search
*******
-------

The ``search`` method allows you to search the Elasticsearch index for documents
matching the provided query. This method takes two arguments:
Expand Down Expand Up @@ -134,7 +134,7 @@ Example:
)

#flush
******
------

Flushes the current buffer to Elasticsearch, pushing all the documents currently
stored in the queue (if there are any).
Expand All @@ -150,7 +150,7 @@ Example:
index.flush

#queue_size
***********
-----------

Returns the current number of documents currently waiting to be flushed to
Elasticsearch:
Expand All @@ -162,7 +162,7 @@ Example
index.queue_size # => 16

#delete_by_query
****************
----------------

This method allows you to remove the documents that match the given query from
the index. The method has a single parameter:
Expand Down