Properly escape underscore in from_ parameter docs

Author: bartier

elasticsearch/client/__init__.py

@@ -668,7 +668,7 @@ def delete_by_query(self, index, body, params=None, headers=None):
         :arg expand_wildcards: Whether to expand wildcard expression to
             concrete indices that are open, closed or both.  Valid choices: open,
             closed, hidden, none, all  Default: open
-        :arg from_: Starting offset (default: 0)
+        :arg from\\_: Starting offset (default: 0)
         :arg ignore_unavailable: Whether specified concrete indices
             should be ignored when unavailable (missing or closed)
         :arg lenient: Specify whether format-based query failures (such
@@ -1423,7 +1423,7 @@ def search(self, body=None, index=None, params=None, headers=None):
             closed, hidden, none, all  Default: open
         :arg explain: Specify whether to return detailed information
             about score computation as part of a hit
-        :arg from_: Starting offset (default: 0)
+        :arg from\\_: Starting offset (default: 0)
         :arg ignore_throttled: Whether specified concrete, expanded or
             aliased indices should be ignored when throttled
         :arg ignore_unavailable: Whether specified concrete indices
@@ -1922,7 +1922,7 @@ def update_by_query(self, index, body=None, params=None, headers=None):
         :arg expand_wildcards: Whether to expand wildcard expression to
             concrete indices that are open, closed or both.  Valid choices: open,
             closed, hidden, none, all  Default: open
-        :arg from_: Starting offset (default: 0)
+        :arg from\\_: Starting offset (default: 0)
         :arg ignore_unavailable: Whether specified concrete indices
             should be ignored when unavailable (missing or closed)
         :arg lenient: Specify whether format-based query failures (such

elasticsearch/client/async_search.py

@@ -125,7 +125,7 @@ def submit(self, body=None, index=None, params=None, headers=None):
             closed, hidden, none, all  Default: open
         :arg explain: Specify whether to return detailed information
             about score computation as part of a hit
-        :arg from_: Starting offset (default: 0)
+        :arg from\\_: Starting offset (default: 0)
         :arg ignore_throttled: Whether specified concrete, expanded or
             aliased indices should be ignored when throttled
         :arg ignore_unavailable: Whether specified concrete indices

elasticsearch/client/cat.py

@@ -653,7 +653,7 @@ def ml_trained_models(self, model_id=None, params=None, headers=None):
             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
-        :arg from_: skips a number of trained models
+        :arg from\\_: skips a number of trained models
         :arg h: Comma-separated list of column names to display
         :arg help: Return help information
         :arg s: Comma-separated list of column names or column aliases
@@ -690,7 +690,7 @@ def transforms(self, transform_id=None, params=None, headers=None):
             transforms have been specified)
         :arg format: a short version of the Accept header, e.g. json,
             yaml
-        :arg from_: skips a number of transform configs, defaults to 0
+        :arg from\\_: skips a number of transform configs, defaults to 0
         :arg h: Comma-separated list of column names to display
         :arg help: Return help information
         :arg s: Comma-separated list of column names or column aliases

elasticsearch/client/ml.py

@@ -352,7 +352,7 @@ def get_buckets(self, job_id, body=None, timestamp=None, params=None, headers=No
         :arg end: End time filter for buckets
         :arg exclude_interim: Exclude interim results
         :arg expand: Include anomaly records
-        :arg from_: skips a number of buckets
+        :arg from\\_: skips a number of buckets
         :arg size: specifies a max number of buckets to get
         :arg sort: Sort buckets by a particular field
         :arg start: Start time filter for buckets
@@ -382,7 +382,7 @@ def get_calendar_events(self, calendar_id, params=None, headers=None):
 
         :arg calendar_id: The ID of the calendar containing the events
         :arg end: Get events before this time
-        :arg from_: Skips a number of events
+        :arg from\\_: Skips a number of events
         :arg job_id: Get events for the job. When this option is used
             calendar_id must be '_all'
         :arg size: Specifies a max number of events to get
@@ -413,7 +413,7 @@ def get_calendars(self, body=None, calendar_id=None, params=None, headers=None):
         :arg body: The from and size parameters optionally sent in the
             body
         :arg calendar_id: The ID of the calendar to fetch
-        :arg from_: skips a number of calendars
+        :arg from\\_: skips a number of calendars
         :arg size: specifies a max number of calendars to get
         """
         # from is a reserved word so it cannot be used, use from_ instead
@@ -471,7 +471,7 @@ def get_filters(self, filter_id=None, params=None, headers=None):
         `<https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-get-filter.html>`_
 
         :arg filter_id: The ID of the filter to fetch
-        :arg from_: skips a number of filters
+        :arg from\\_: skips a number of filters
         :arg size: specifies a max number of filters to get
         """
         # from is a reserved word so it cannot be used, use from_ instead
@@ -506,7 +506,7 @@ def get_influencers(self, job_id, body=None, params=None, headers=None):
             order
         :arg end: end timestamp for the requested influencers
         :arg exclude_interim: Exclude interim results
-        :arg from_: skips a number of influencers
+        :arg from\\_: skips a number of influencers
         :arg influencer_score: influencer score threshold for the
             requested influencers
         :arg size: specifies a max number of influencers to get
@@ -632,7 +632,7 @@ def get_records(self, job_id, body=None, params=None, headers=None):
         :arg desc: Set the sort direction
         :arg end: End time filter for records
         :arg exclude_interim: Exclude interim results
-        :arg from_: skips a number of records
+        :arg from\\_: skips a number of records
         :arg record_score: Returns records with anomaly scores greater
             or equal than this value
         :arg size: specifies a max number of records to get
@@ -1092,7 +1092,7 @@ def get_data_frame_analytics(self, id=None, params=None, headers=None):
         :arg allow_no_match: Whether to ignore if a wildcard expression
             matches no data frame analytics. (This includes `_all` string or when no
             data frame analytics have been specified)  Default: True
-        :arg from_: skips a number of analytics
+        :arg from\\_: skips a number of analytics
         :arg size: specifies a max number of analytics to get  Default:
             100
         """
@@ -1117,7 +1117,7 @@ def get_data_frame_analytics_stats(self, id=None, params=None, headers=None):
         :arg allow_no_match: Whether to ignore if a wildcard expression
             matches no data frame analytics. (This includes `_all` string or when no
             data frame analytics have been specified)  Default: True
-        :arg from_: skips a number of analytics
+        :arg from\\_: skips a number of analytics
         :arg size: specifies a max number of analytics to get  Default:
             100
         """
@@ -1241,7 +1241,7 @@ def get_trained_models(self, model_id=None, params=None, headers=None):
         :arg decompress_definition: Should the model definition be
             decompressed into valid JSON or returned in a custom compressed format.
             Defaults to true.  Default: True
-        :arg from_: skips a number of trained models
+        :arg from\\_: skips a number of trained models
         :arg include_model_definition: Should the full model definition
             be included in the results. These definitions can be large. So be
             cautious when including them. Defaults to false.
@@ -1271,7 +1271,7 @@ def get_trained_models_stats(self, model_id=None, params=None, headers=None):
         :arg allow_no_match: Whether to ignore if a wildcard expression
             matches no trained models. (This includes `_all` string or when no
             trained models have been specified)  Default: True
-        :arg from_: skips a number of trained models
+        :arg from\\_: skips a number of trained models
         :arg size: specifies a max number of trained models to get
             Default: 100
         """
@@ -1358,7 +1358,7 @@ def get_categories(
         :arg body: Category selection details if not provided in URI
         :arg category_id: The identifier of the category definition of
             interest
-        :arg from_: skips a number of categories
+        :arg from\\_: skips a number of categories
         :arg size: specifies a max number of categories to get
         """
         # from is a reserved word so it cannot be used, use from_ instead
@@ -1392,7 +1392,7 @@ def get_model_snapshots(
         :arg desc: True if the results should be sorted in descending
             order
         :arg end: The filter 'end' query parameter
-        :arg from_: Skips a number of documents
+        :arg from\\_: Skips a number of documents
         :arg size: The default number of documents returned in queries
             as a string.
         :arg sort: Name of the field to sort on

elasticsearch/client/transform.py

@@ -41,7 +41,7 @@ def get_transform(self, transform_id=None, params=None, headers=None):
         :arg allow_no_match: Whether to ignore if a wildcard expression
             matches no transforms. (This includes `_all` string or when no
             transforms have been specified)
-        :arg from_: skips a number of transform configs, defaults to 0
+        :arg from\\_: skips a number of transform configs, defaults to 0
         :arg size: specifies a max number of transforms to get, defaults
             to 100
         """
@@ -67,7 +67,7 @@ def get_transform_stats(self, transform_id, params=None, headers=None):
         :arg allow_no_match: Whether to ignore if a wildcard expression
             matches no transforms. (This includes `_all` string or when no
             transforms have been specified)
-        :arg from_: skips a number of transform stats, defaults to 0
+        :arg from\\_: skips a number of transform stats, defaults to 0
         :arg size: specifies a max number of transform stats to get,
             defaults to 100
         """

utils/templates/base

@@ -12,7 +12,7 @@
 
         {% for p, info in api.params %}
         {% filter wordwrap(72, wrapstring="\n            ") %}
-        :arg {{ p }}: {{ info.description }} {% if info.options %}  Valid choices: {{ info.options|join(", ") }}{% endif %} {% if info.default %}  Default: {{ info.default }}{% endif %}
+        :arg {{ 'from\\\\_' if p == 'from_' else p }}: {{ info.description }} {% if info.options %}  Valid choices: {{ info.options|join(", ") }}{% endif %} {% if info.default %}  Default: {{ info.default }}{% endif %}
         {% endfilter %}
 
         {% endfor %}