Skip to content

Commit d337e13

Browse files
authored
Clarify shorthand (#843)
1 parent 98ecaa7 commit d337e13

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

src/reference/config/shorthand.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
We often use a compact single-line notation to refer to nested config items:
1+
In the documentation, we often use a compact single-line notation to refer to
2+
nested config items, where we drop the additional brackets at each level:
23

34
``[section]``
45
An entire section.
56
``[section]setting``
67
A setting within a section.
78
``[section]setting=value``
89
The value of a setting within a section.
9-
``[section][sub-section]another-setting``
10+
``[section][sub section]another setting``
1011
A setting within a sub-section.
1112

12-
In the file, however, section headings need additional brackets at each level.
13+
This is purely for making it easier to refer to items; they cannot be written
14+
this way in the ``flow.cylc`` file.

src/tutorial/scheduling/graphing.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ Example
5555
String
5656
"""
5757
58-
Shorthand
59-
^^^^^^^^^
58+
.. admonition:: Shorthand
59+
:class: tip
6060

61-
.. include:: ../../reference/config/shorthand.rst
61+
.. include:: ../../reference/config/shorthand.rst
6262

6363
Duplicate Items
6464
^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)