Skip to content

Commit fd16cd5

Browse files
authored
Merge pull request #163 from rachel-mack/DOCSP-33817-disable-fail
Clarification of acceptable use of "fail" and "disable"
2 parents c2bae29 + ade5dcb commit fd16cd5

File tree

3 files changed

+9
-5
lines changed

3 files changed

+9
-5
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,8 @@ D
109109
-
110110

111111
disabled
112-
:icon-fa4:`exclamation-triangle` Don't use *disabled* to describe
113-
inactive commands, options, or buttons on the interface. Use
112+
:icon-fa4:`exclamation-triangle` Use *inactive* to describe
113+
commands, options, toggles, or buttons in the interface. Use
114114
*dimmed* to describe the appearance of an inactive command,
115115
option, or button; use *unavailable* to refer to its state. Don't
116116
use *disabled* to refer to individuals with disabilities.

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ F
44
.. glossary::
55

66
fail to
7-
:icon-fa4:`times-circle` Use *unable to* instead.
7+
:icon-fa4:`times-circle` Use *unable to* when you when refer to an individual or
8+
company.
9+
10+
You may use *fail* to describe system performance.
811

912
FAQ
1013
Use the acronym *FAQ* to refer to an article or section that

source/style-guide/writing/use-positive-statements.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,9 @@ and are typically shorter.
3131
Avoid Negative Words
3232
--------------------
3333

34-
Try to avoid the following negative words, using instead the suggested
35-
alternatives. However, always be honest and transparent about issues.
34+
Try to avoid the following negative words, using instead the suggested alternatives,
35+
particularly in reference to the user or the company. However, always communicate honestly and
36+
transparently about issues, and accurately describe a system's performance.
3637

3738
.. list-table::
3839
:widths: 50 50

0 commit comments

Comments
 (0)