diff options
| author | Emilio Jesus Gallego Arias | 2020-06-11 16:42:13 +0200 |
|---|---|---|
| committer | Emilio Jesus Gallego Arias | 2020-06-11 16:42:13 +0200 |
| commit | 55d1ea37042cf589d9aae7450806e42f5e571403 (patch) | |
| tree | 5bd2c8c6ef067378eae0367f81e96f7469707ecd /doc/sphinx/language/core/basic.rst | |
| parent | 965c0957d4608b6896787f122475df9a669c8c08 (diff) | |
| parent | daddc14db590ce40bd528c5ee443c0e1d3c32cbb (diff) | |
Merge PR #12481: Minor improvements to the sections on basics and sorts.
Reviewed-by: jfehrle
Diffstat (limited to 'doc/sphinx/language/core/basic.rst')
| -rw-r--r-- | doc/sphinx/language/core/basic.rst | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/doc/sphinx/language/core/basic.rst b/doc/sphinx/language/core/basic.rst index d7f7259ab0..64b29c1c0b 100644 --- a/doc/sphinx/language/core/basic.rst +++ b/doc/sphinx/language/core/basic.rst @@ -417,8 +417,16 @@ more precise description of the scope of these settings): .. FIXME Convert "Extraction Language" to an option. -Flags, options and tables are identified by a series of identifiers, each with an initial -capital letter. +.. insertprodn setting_name setting_name + +.. prodn:: + setting_name ::= {+ @ident } + +.. + + Flags, options and tables are identified by a series of + identifiers. By convention, each of the identifiers start with an + initial capital letter. Flags, options and tables appear in the HTML documentation in blue or gray boxes after the labels "Flag", "Option" and "Table". In the pdf, @@ -428,11 +436,6 @@ they appear after a boldface label. They are listed in the .. cmd:: Set @setting_name {? {| @int | @string } } :name: Set - .. insertprodn setting_name setting_name - - .. prodn:: - setting_name ::= {+ @ident } - If :n:`@setting_name` is a flag, no value may be provided; the flag is set to on. If :n:`@setting_name` is an option, a value of the appropriate type @@ -533,4 +536,4 @@ Newly opened modules and sections inherit the current settings. :cmd:`Unset` commands. If your goal is to define project-wide settings, you should rather use the command-line arguments ``-set`` and ``-unset`` for setting flags and options - (cf. :ref:`command-line-options`). + (see :ref:`command-line-options`). |
