Skip to content

Commit 403d0c6

Browse files
authored
(DOCSP-11947), (DOCSP-40563), (DOCSP-41106): Updates for timestamps, procedures, and toggles. (#173)
* (DOCSP-11947), (DOCSP-40563), (DOCSP-41106): Updates for timestamps, procedures, and toggles. * (DOCSP-11947): Incorporated Jeff's feedback.
1 parent 3c910f4 commit 403d0c6

File tree

3 files changed

+29
-3
lines changed

3 files changed

+29
-3
lines changed

source/style-guide/includes/terms/d.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,14 @@ D
3131
database
3232
Use *database* as one word.
3333

34+
date
35+
:icon-fa4:`times-circle` Use *timestamp* instead of *date*
36+
wherever applicable to avoid confusion.
37+
38+
.. seealso::
39+
40+
:term:`timestamp`
41+
3442
default
3543
Use *default* as a noun or adjective. Don't use *default* as a
3644
verb.

source/style-guide/includes/terms/t.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,11 +140,20 @@ T
140140
*timeout* as one word when using the term as a noun or adjective.
141141

142142
timestamp
143-
Use *timestamp* as one word. Use only as a noun.
143+
Use *timestamp* as one word. Use only as a noun. Use *timestamp*
144+
instead of *date* wherever applicable to avoid confusion.
145+
146+
.. seealso::
147+
148+
:term:`date`
144149

145150
time zone
146151
Use *time zone* as two words.
147152

153+
toggle
154+
Use *toggle* as a noun for the UI element that switches between
155+
two modes, usually :guilabel:`On` and :guilabel:`Off`.
156+
148157
toolbar
149158
**toolbox**
150159
**toolkit**

source/style-guide/style/tasks.txt

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,17 @@ Procedures
9696
A task contains one or more *procedures* or sets of sequential action
9797
steps. Consider the following guidelines when creating a procedure:
9898

99-
- If the procedure has more than one step, use a ``steps`` file for
100-
the steps. Don't use bullets, except to list choices within a step.
99+
- If the procedure has more than one step, use the ``.. procedure::``
100+
directive for the steps. Don't use bullets, except to list choices
101+
within a step.
102+
- If the procedure has more than one step, follow the guidance for
103+
introducing lists to introduce the procedure. To learn more, see
104+
:ref:`lists`.
105+
- If a procedure has nested steps, use ordered lists within the
106+
``.. step::`` directive. The first level of nesting should use
107+
``a, b, c``, and so on. The next level of nesting should use
108+
``i, ii, iii``, and so on. Don't nest any more than that. To learn
109+
more, see :ref:`lists`.
101110
- If the procedure has only one step, show that step in a regular
102111
paragraph. That is, don't number it.
103112
- If you have lengthy introductory or prerequisite information, or if

0 commit comments

Comments
 (0)