Skip to content

Commit

Permalink
Standardize docs spacing for 'Valid values' and 'Default'
Browse files Browse the repository at this point in the history
  • Loading branch information
sethmlarson committed Feb 21, 2020
1 parent df8e556 commit 35f263c
Show file tree
Hide file tree
Showing 10 changed files with 152 additions and 152 deletions.
92 changes: 46 additions & 46 deletions elasticsearch/client/__init__.py

Large diffs are not rendered by default.

34 changes: 17 additions & 17 deletions elasticsearch/client/cat.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ def allocation(self, node_id=None, params=None):
:arg node_id: A comma-separated list of node IDs or names to
limit the returned information
:arg bytes: The unit in which to display byte values Valid
:arg bytes: The unit in which to display byte values Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
:arg format: a short version of the Accept header, e.g. json,
yaml
Expand Down Expand Up @@ -84,7 +84,7 @@ def health(self, params=None):
:arg help: Return help information
:arg s: Comma-separated list of column names or column aliases
to sort by
:arg time: The unit in which to display time values Valid
:arg time: The unit in which to display time values Valid
choices: d (Days), h (Hours), m (Minutes), s (Seconds), ms
(Milliseconds), micros (Microseconds), nanos (Nanoseconds)
:arg ts: Set to false to disable timestamping Default: True
Expand Down Expand Up @@ -126,13 +126,13 @@ def indices(self, index=None, params=None):
:arg index: A comma-separated list of index names to limit the
returned information
:arg bytes: The unit in which to display byte values Valid
:arg bytes: The unit in which to display byte values Valid
choices: b, k, m, g
:arg format: a short version of the Accept header, e.g. json,
yaml
:arg h: Comma-separated list of column names to display
:arg health: A health status ("green", "yellow", or "red" to
filter only indices matching the specified health status Valid choices:
filter only indices matching the specified health status Valid choices:
green, yellow, red
:arg help: Return help information
:arg include_unloaded_segments: If set to true segment stats
Expand All @@ -145,7 +145,7 @@ def indices(self, index=None, params=None):
:arg pri: Set to true to return stats only for primary shards
:arg s: Comma-separated list of column names or column aliases
to sort by
:arg time: The unit in which to display time values Valid
:arg time: The unit in which to display time values Valid
choices: d (Days), h (Hours), m (Minutes), s (Seconds), ms
(Milliseconds), micros (Microseconds), nanos (Nanoseconds)
:arg v: Verbose mode. Display column headers
Expand Down Expand Up @@ -191,7 +191,7 @@ def nodes(self, params=None):
Returns basic statistics about performance of cluster nodes.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html>`_
:arg bytes: The unit in which to display byte values Valid
:arg bytes: The unit in which to display byte values Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
:arg format: a short version of the Accept header, e.g. json,
yaml
Expand All @@ -205,7 +205,7 @@ def nodes(self, params=None):
to master node
:arg s: Comma-separated list of column names or column aliases
to sort by
:arg time: The unit in which to display time values Valid
:arg time: The unit in which to display time values Valid
choices: d (Days), h (Hours), m (Minutes), s (Seconds), ms
(Milliseconds), micros (Microseconds), nanos (Nanoseconds)
:arg v: Verbose mode. Display column headers
Expand All @@ -224,7 +224,7 @@ def recovery(self, index=None, params=None):
names to limit the returned information
:arg active_only: If `true`, the response only includes ongoing
shard recoveries
:arg bytes: The unit in which to display byte values Valid
:arg bytes: The unit in which to display byte values Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
:arg detailed: If `true`, the response includes detailed
information about shard recoveries
Expand All @@ -236,7 +236,7 @@ def recovery(self, index=None, params=None):
names to limit the returned information
:arg s: Comma-separated list of column names or column aliases
to sort by
:arg time: The unit in which to display time values Valid
:arg time: The unit in which to display time values Valid
choices: d (Days), h (Hours), m (Minutes), s (Seconds), ms
(Milliseconds), micros (Microseconds), nanos (Nanoseconds)
:arg v: Verbose mode. Display column headers
Expand All @@ -255,7 +255,7 @@ def shards(self, index=None, params=None):
:arg index: A comma-separated list of index names to limit the
returned information
:arg bytes: The unit in which to display byte values Valid
:arg bytes: The unit in which to display byte values Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
:arg format: a short version of the Accept header, e.g. json,
yaml
Expand All @@ -267,7 +267,7 @@ def shards(self, index=None, params=None):
to master node
:arg s: Comma-separated list of column names or column aliases
to sort by
:arg time: The unit in which to display time values Valid
:arg time: The unit in which to display time values Valid
choices: d (Days), h (Hours), m (Minutes), s (Seconds), ms
(Milliseconds), micros (Microseconds), nanos (Nanoseconds)
:arg v: Verbose mode. Display column headers
Expand All @@ -284,7 +284,7 @@ def segments(self, index=None, params=None):
:arg index: A comma-separated list of index names to limit the
returned information
:arg bytes: The unit in which to display byte values Valid
:arg bytes: The unit in which to display byte values Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
:arg format: a short version of the Accept header, e.g. json,
yaml
Expand Down Expand Up @@ -314,7 +314,7 @@ def pending_tasks(self, params=None):
to master node
:arg s: Comma-separated list of column names or column aliases
to sort by
:arg time: The unit in which to display time values Valid
:arg time: The unit in which to display time values Valid
choices: d (Days), h (Hours), m (Minutes), s (Seconds), ms
(Milliseconds), micros (Microseconds), nanos (Nanoseconds)
:arg v: Verbose mode. Display column headers
Expand Down Expand Up @@ -342,7 +342,7 @@ def thread_pool(self, thread_pool_patterns=None, params=None):
to master node
:arg s: Comma-separated list of column names or column aliases
to sort by
:arg size: The multiplier in which to display values Valid
:arg size: The multiplier in which to display values Valid
choices: , k, m, g, t, p
:arg v: Verbose mode. Display column headers
"""
Expand All @@ -361,7 +361,7 @@ def fielddata(self, fields=None, params=None):
:arg fields: A comma-separated list of fields to return the
fielddata size
:arg bytes: The unit in which to display byte values Valid
:arg bytes: The unit in which to display byte values Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
:arg fields: A comma-separated list of fields to return in the
output
Expand Down Expand Up @@ -459,7 +459,7 @@ def snapshots(self, repository=None, params=None):
to master node
:arg s: Comma-separated list of column names or column aliases
to sort by
:arg time: The unit in which to display time values Valid
:arg time: The unit in which to display time values Valid
choices: d (Days), h (Hours), m (Minutes), s (Seconds), ms
(Milliseconds), micros (Microseconds), nanos (Nanoseconds)
:arg v: Verbose mode. Display column headers
Expand Down Expand Up @@ -501,7 +501,7 @@ def tasks(self, params=None):
Set to -1 to return all.
:arg s: Comma-separated list of column names or column aliases
to sort by
:arg time: The unit in which to display time values Valid
:arg time: The unit in which to display time values Valid
choices: d (Days), h (Hours), m (Minutes), s (Seconds), ms
(Milliseconds), micros (Microseconds), nanos (Nanoseconds)
:arg v: Verbose mode. Display column headers
Expand Down
16 changes: 8 additions & 8 deletions elasticsearch/client/cluster.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ def health(self, index=None, params=None):
:arg index: Limit the information returned to a specific index
:arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices: open,
closed, none, all Default: all
concrete indices that are open, closed or both. Valid choices: open,
closed, none, all Default: all
:arg level: Specify the level of detail for returned information
Valid choices: cluster, indices, shards Default: cluster
Valid choices: cluster, indices, shards Default: cluster
:arg local: Return local information, do not retrieve the state
from master node (default: false)
:arg master_timeout: Explicit operation timeout for connection
Expand All @@ -34,7 +34,7 @@ def health(self, index=None, params=None):
:arg wait_for_active_shards: Wait until the specified number of
shards is active
:arg wait_for_events: Wait until all currently queued events
with the given priority are processed Valid choices: immediate, urgent,
with the given priority are processed Valid choices: immediate, urgent,
high, normal, low, languid
:arg wait_for_no_initializing_shards: Whether to wait until
there are no initializing shards in the cluster
Expand Down Expand Up @@ -80,16 +80,16 @@ def state(self, metric=None, index=None, params=None):
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html>`_
:arg metric: Limit the information returned to the specified
metrics Valid choices: _all, blocks, metadata, nodes, routing_table,
metrics Valid choices: _all, blocks, metadata, nodes, routing_table,
routing_nodes, master_node, version
:arg index: A comma-separated list of index names; use `_all` or
empty string to perform the operation on all indices
:arg allow_no_indices: Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes `_all`
string or when no indices have been specified)
:arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices: open,
closed, none, all Default: open
concrete indices that are open, closed or both. Valid choices: open,
closed, none, all Default: open
:arg flat_settings: Return settings in flat format (default:
false)
:arg ignore_unavailable: Whether specified concrete indices
Expand Down Expand Up @@ -145,7 +145,7 @@ def reroute(self, body=None, params=None):
:arg master_timeout: Explicit operation timeout for connection
to master node
:arg metric: Limit the information returned to the specified
metrics. Defaults to all but metadata Valid choices: _all, blocks,
metrics. Defaults to all but metadata Valid choices: _all, blocks,
metadata, nodes, routing_table, master_node, version
:arg retry_failed: Retries allocation of shards that are blocked
due to too many subsequent allocation failures
Expand Down
Loading

0 comments on commit 35f263c

Please sign in to comment.