diff options
Diffstat (limited to 'doc/development/documentation/styleguide.md')
| -rw-r--r-- | doc/development/documentation/styleguide.md | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 744f0de685a..c105f54d125 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -592,13 +592,15 @@ In most cases, content considered for a note should be included: - As its own standalone paragraph. - As content under a new subheading that introduces the topic, making it more visible/findable. -When to use notes: +#### When to use -- Use a note when there is a reason that most or all readers who browse the section - should see the content; i.e. if missed, it’s likely to cause major trouble for - a minority of users or significant trouble for a majority of users. Weigh the - costs of distracting users to whom the content is not relevant against - the cost of users missing the content if it were not expressed as a note. +Use a note when there is a reason that most or all readers who browse the +section should see the content. That is, if missed, it’s likely to cause +major trouble for a minority of users or significant trouble for a majority +of users. + +Weigh the costs of distracting users to whom the content is not relevant against +the cost of users missing the content if it were not expressed as a note. ```md NOTE: **Note:** |