diff --git a/doc/syntax.rst b/doc/syntax.rst index ad0facd70c45..c6cd865ada8b 100644 --- a/doc/syntax.rst +++ b/doc/syntax.rst @@ -491,9 +491,9 @@ Range Format Specifications Format specifications for range types have the following syntax: .. productionlist:: sf - range_format_spec: [":" [`n`][`range_type`][`range_underlying_spec`]] + range_format_spec: [":" ["n"][`range_type`][`range_underlying_spec`]] -The `n` option formats the range without the opening and closing brackets. +The ``'n'`` option formats the range without the opening and closing brackets. The available presentation types for `range_type` are: @@ -505,18 +505,18 @@ The available presentation types for `range_type` are: | ``'?s'``| Debug format. The range is formatted as an escaped | | | string. | +---------+----------------------------------------------------------+ -| none | Default format. The range is formatted with a separator | +| none | Default format. The range is formatted with a separator. | | | | +---------+----------------------------------------------------------+ -If `range_type` is `s` or `?s`, the underlying type of the range must be a character type. The -`n` option and `range_underlying_spec` are mutually exclusive with `s` and `?s`. +If `range_type` is ``'s'`` or ``'?s'``, the underlying type of the range must be a character type. The +``'n'`` option and `range_underlying_spec` are mutually exclusive with ``'s'`` and ``'?s'``. -The `underlying_spec` is parsed based on the formatter of the range's +The `range_underlying_spec` is parsed based on the formatter of the range's reference type. By default, a range of characters or strings is printed escaped and quoted. But -if any `underlying_spec` is provided (even if it is empty), then the characters +if any `range_underlying_spec` is provided (even if it is empty), then the characters or strings are printed according to the provided specification. Examples::