Skip to content

Commit 35f263c

Browse files
committed
Standardize docs spacing for 'Valid values' and 'Default'
1 parent df8e556 commit 35f263c

File tree

10 files changed

+152
-152
lines changed

10 files changed

+152
-152
lines changed

elasticsearch/client/__init__.py

+46-46
Large diffs are not rendered by default.

elasticsearch/client/cat.py

+17-17
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ def allocation(self, node_id=None, params=None):
3333
3434
:arg node_id: A comma-separated list of node IDs or names to
3535
limit the returned information
36-
:arg bytes: The unit in which to display byte values Valid
36+
:arg bytes: The unit in which to display byte values Valid
3737
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
3838
:arg format: a short version of the Accept header, e.g. json,
3939
yaml
@@ -84,7 +84,7 @@ def health(self, params=None):
8484
:arg help: Return help information
8585
:arg s: Comma-separated list of column names or column aliases
8686
to sort by
87-
:arg time: The unit in which to display time values Valid
87+
:arg time: The unit in which to display time values Valid
8888
choices: d (Days), h (Hours), m (Minutes), s (Seconds), ms
8989
(Milliseconds), micros (Microseconds), nanos (Nanoseconds)
9090
:arg ts: Set to false to disable timestamping Default: True
@@ -126,13 +126,13 @@ def indices(self, index=None, params=None):
126126
127127
:arg index: A comma-separated list of index names to limit the
128128
returned information
129-
:arg bytes: The unit in which to display byte values Valid
129+
:arg bytes: The unit in which to display byte values Valid
130130
choices: b, k, m, g
131131
:arg format: a short version of the Accept header, e.g. json,
132132
yaml
133133
:arg h: Comma-separated list of column names to display
134134
:arg health: A health status ("green", "yellow", or "red" to
135-
filter only indices matching the specified health status Valid choices:
135+
filter only indices matching the specified health status Valid choices:
136136
green, yellow, red
137137
:arg help: Return help information
138138
:arg include_unloaded_segments: If set to true segment stats
@@ -145,7 +145,7 @@ def indices(self, index=None, params=None):
145145
:arg pri: Set to true to return stats only for primary shards
146146
:arg s: Comma-separated list of column names or column aliases
147147
to sort by
148-
:arg time: The unit in which to display time values Valid
148+
:arg time: The unit in which to display time values Valid
149149
choices: d (Days), h (Hours), m (Minutes), s (Seconds), ms
150150
(Milliseconds), micros (Microseconds), nanos (Nanoseconds)
151151
:arg v: Verbose mode. Display column headers
@@ -191,7 +191,7 @@ def nodes(self, params=None):
191191
Returns basic statistics about performance of cluster nodes.
192192
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html>`_
193193
194-
:arg bytes: The unit in which to display byte values Valid
194+
:arg bytes: The unit in which to display byte values Valid
195195
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
196196
:arg format: a short version of the Accept header, e.g. json,
197197
yaml
@@ -205,7 +205,7 @@ def nodes(self, params=None):
205205
to master node
206206
:arg s: Comma-separated list of column names or column aliases
207207
to sort by
208-
:arg time: The unit in which to display time values Valid
208+
:arg time: The unit in which to display time values Valid
209209
choices: d (Days), h (Hours), m (Minutes), s (Seconds), ms
210210
(Milliseconds), micros (Microseconds), nanos (Nanoseconds)
211211
:arg v: Verbose mode. Display column headers
@@ -224,7 +224,7 @@ def recovery(self, index=None, params=None):
224224
names to limit the returned information
225225
:arg active_only: If `true`, the response only includes ongoing
226226
shard recoveries
227-
:arg bytes: The unit in which to display byte values Valid
227+
:arg bytes: The unit in which to display byte values Valid
228228
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
229229
:arg detailed: If `true`, the response includes detailed
230230
information about shard recoveries
@@ -236,7 +236,7 @@ def recovery(self, index=None, params=None):
236236
names to limit the returned information
237237
:arg s: Comma-separated list of column names or column aliases
238238
to sort by
239-
:arg time: The unit in which to display time values Valid
239+
:arg time: The unit in which to display time values Valid
240240
choices: d (Days), h (Hours), m (Minutes), s (Seconds), ms
241241
(Milliseconds), micros (Microseconds), nanos (Nanoseconds)
242242
:arg v: Verbose mode. Display column headers
@@ -255,7 +255,7 @@ def shards(self, index=None, params=None):
255255
256256
:arg index: A comma-separated list of index names to limit the
257257
returned information
258-
:arg bytes: The unit in which to display byte values Valid
258+
:arg bytes: The unit in which to display byte values Valid
259259
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
260260
:arg format: a short version of the Accept header, e.g. json,
261261
yaml
@@ -267,7 +267,7 @@ def shards(self, index=None, params=None):
267267
to master node
268268
:arg s: Comma-separated list of column names or column aliases
269269
to sort by
270-
:arg time: The unit in which to display time values Valid
270+
:arg time: The unit in which to display time values Valid
271271
choices: d (Days), h (Hours), m (Minutes), s (Seconds), ms
272272
(Milliseconds), micros (Microseconds), nanos (Nanoseconds)
273273
:arg v: Verbose mode. Display column headers
@@ -284,7 +284,7 @@ def segments(self, index=None, params=None):
284284
285285
:arg index: A comma-separated list of index names to limit the
286286
returned information
287-
:arg bytes: The unit in which to display byte values Valid
287+
:arg bytes: The unit in which to display byte values Valid
288288
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
289289
:arg format: a short version of the Accept header, e.g. json,
290290
yaml
@@ -314,7 +314,7 @@ def pending_tasks(self, params=None):
314314
to master node
315315
:arg s: Comma-separated list of column names or column aliases
316316
to sort by
317-
:arg time: The unit in which to display time values Valid
317+
:arg time: The unit in which to display time values Valid
318318
choices: d (Days), h (Hours), m (Minutes), s (Seconds), ms
319319
(Milliseconds), micros (Microseconds), nanos (Nanoseconds)
320320
:arg v: Verbose mode. Display column headers
@@ -342,7 +342,7 @@ def thread_pool(self, thread_pool_patterns=None, params=None):
342342
to master node
343343
:arg s: Comma-separated list of column names or column aliases
344344
to sort by
345-
:arg size: The multiplier in which to display values Valid
345+
:arg size: The multiplier in which to display values Valid
346346
choices: , k, m, g, t, p
347347
:arg v: Verbose mode. Display column headers
348348
"""
@@ -361,7 +361,7 @@ def fielddata(self, fields=None, params=None):
361361
362362
:arg fields: A comma-separated list of fields to return the
363363
fielddata size
364-
:arg bytes: The unit in which to display byte values Valid
364+
:arg bytes: The unit in which to display byte values Valid
365365
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
366366
:arg fields: A comma-separated list of fields to return in the
367367
output
@@ -459,7 +459,7 @@ def snapshots(self, repository=None, params=None):
459459
to master node
460460
:arg s: Comma-separated list of column names or column aliases
461461
to sort by
462-
:arg time: The unit in which to display time values Valid
462+
:arg time: The unit in which to display time values Valid
463463
choices: d (Days), h (Hours), m (Minutes), s (Seconds), ms
464464
(Milliseconds), micros (Microseconds), nanos (Nanoseconds)
465465
:arg v: Verbose mode. Display column headers
@@ -501,7 +501,7 @@ def tasks(self, params=None):
501501
Set to -1 to return all.
502502
:arg s: Comma-separated list of column names or column aliases
503503
to sort by
504-
:arg time: The unit in which to display time values Valid
504+
:arg time: The unit in which to display time values Valid
505505
choices: d (Days), h (Hours), m (Minutes), s (Seconds), ms
506506
(Milliseconds), micros (Microseconds), nanos (Nanoseconds)
507507
:arg v: Verbose mode. Display column headers

elasticsearch/client/cluster.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ def health(self, index=None, params=None):
2222
2323
:arg index: Limit the information returned to a specific index
2424
:arg expand_wildcards: Whether to expand wildcard expression to
25-
concrete indices that are open, closed or both. Valid choices: open,
26-
closed, none, all Default: all
25+
concrete indices that are open, closed or both. Valid choices: open,
26+
closed, none, all Default: all
2727
:arg level: Specify the level of detail for returned information
28-
Valid choices: cluster, indices, shards Default: cluster
28+
Valid choices: cluster, indices, shards Default: cluster
2929
:arg local: Return local information, do not retrieve the state
3030
from master node (default: false)
3131
:arg master_timeout: Explicit operation timeout for connection
@@ -34,7 +34,7 @@ def health(self, index=None, params=None):
3434
:arg wait_for_active_shards: Wait until the specified number of
3535
shards is active
3636
:arg wait_for_events: Wait until all currently queued events
37-
with the given priority are processed Valid choices: immediate, urgent,
37+
with the given priority are processed Valid choices: immediate, urgent,
3838
high, normal, low, languid
3939
:arg wait_for_no_initializing_shards: Whether to wait until
4040
there are no initializing shards in the cluster
@@ -80,16 +80,16 @@ def state(self, metric=None, index=None, params=None):
8080
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html>`_
8181
8282
:arg metric: Limit the information returned to the specified
83-
metrics Valid choices: _all, blocks, metadata, nodes, routing_table,
83+
metrics Valid choices: _all, blocks, metadata, nodes, routing_table,
8484
routing_nodes, master_node, version
8585
:arg index: A comma-separated list of index names; use `_all` or
8686
empty string to perform the operation on all indices
8787
:arg allow_no_indices: Whether to ignore if a wildcard indices
8888
expression resolves into no concrete indices. (This includes `_all`
8989
string or when no indices have been specified)
9090
:arg expand_wildcards: Whether to expand wildcard expression to
91-
concrete indices that are open, closed or both. Valid choices: open,
92-
closed, none, all Default: open
91+
concrete indices that are open, closed or both. Valid choices: open,
92+
closed, none, all Default: open
9393
:arg flat_settings: Return settings in flat format (default:
9494
false)
9595
:arg ignore_unavailable: Whether specified concrete indices
@@ -145,7 +145,7 @@ def reroute(self, body=None, params=None):
145145
:arg master_timeout: Explicit operation timeout for connection
146146
to master node
147147
:arg metric: Limit the information returned to the specified
148-
metrics. Defaults to all but metadata Valid choices: _all, blocks,
148+
metrics. Defaults to all but metadata Valid choices: _all, blocks,
149149
metadata, nodes, routing_table, master_node, version
150150
:arg retry_failed: Retries allocation of shards that are blocked
151151
due to too many subsequent allocation failures

0 commit comments

Comments
 (0)