[BUG] Elasticsearch timeout docs have incomplete values

Open
#3,234 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
42/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
elasticsearch
Domain
documentation

Research direction

Search the documentation for the timeout description that lists only -1 and 0, then compare it with the linked Elasticsearch API reference. Update the documented values to reflect supported Elastic time strings, and verify the rendered documentation no longer presents the incomplete list.

Written by the indexing model from the issue text.

Description

In the documentation for timeouts on a query documentation specifies the timeout can be either -1 or 0 when really it's any supported Elastic time string.

https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-create

Dominant language
Ruby
Stars
265
Forks
347
Avg merge
3d 15h
Merged PRs (30d)
2

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from elastic/docs

All issues in elastic/docs

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.