From b62cc7c716afb3db115ee6366496aa62f779d0a4 Mon Sep 17 00:00:00 2001 From: Richard Boulton Date: Mon, 21 Oct 2013 12:37:50 +0100 Subject: [PATCH] Clean up wording to reduce confusion The description of the timeout parameter was worded misleadingly; it implied that the API would wait until the cluster reached the desired level and then stayed at that level for the timeout. I've tweaked the sentence to remove the risk of confusion. --- docs/reference/cluster/health.asciidoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/reference/cluster/health.asciidoc b/docs/reference/cluster/health.asciidoc index 52685de9f48..48108e145be 100644 --- a/docs/reference/cluster/health.asciidoc +++ b/docs/reference/cluster/health.asciidoc @@ -38,9 +38,9 @@ status is controlled by the worst index status. One of the main benefits of the API is the ability to wait until the cluster reaches a certain high water-mark health level. For example, the -following will wait till the cluster reaches the `yellow` level for 50 -seconds (if it reaches the `green` or `yellow` status beforehand, it -will return): +following will wait for 50 seconds for the cluster to reach the `yellow` +level (if it reaches the `green` or `yellow` status before 50 seconds elapse, +it will return at that point): [source,js] --------------------------------------------------