-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
48 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
; Vale configuration file to test the `Symbols` rule | ||
StylesPath = ../../../styles | ||
MinAlertLevel = suggestion | ||
[*.adoc] | ||
RedHat.Symbols = YES |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Don't use this ! | ||
or this! | ||
Don't use this & that | ||
This + that is not OK. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
:!attribute: | ||
:attribute!: | ||
\include::example.adoc[leveloffset=+1] | ||
and is ok. | ||
Use of C++ is OK. | ||
don't use an exclamation mark | ||
kbd:[Ctrl + a] | ||
kbd:[Ctrl + shift + a] | ||
plus symbol is fine | ||
Use the "!" symbol | ||
Use the "&" symbol | ||
Use the "+" symbol |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
extends: existence | ||
level: warning | ||
scope: raw | ||
link: https://redhat-documentation.github.io/supplementary-style-guide/#_symbols | ||
message: "Do not use the '%s' symbol in original body copy." | ||
nonword: true | ||
tokens: | ||
- '(?<![":])\!(?![":])' | ||
- '(?<!")\&(?!")' | ||
- '(?<!")\+(?!.*\]|\")' | ||
exceptions: | ||
- C\+\+ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
:navtitle: Symbols | ||
:keywords: reference, rule, Symbols | ||
|
||
= Symbols | ||
|
||
Do not use symbols such as ampersand (`&`), exclamation point (`!`), or plus symbol (`+`) in original body copy. | ||
|
||
.Additional resources | ||
|
||
* link:https://redhat-documentation.github.io/supplementary-style-guide/#_symbols[] |