-
Notifications
You must be signed in to change notification settings - Fork 8
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
1 parent
3594801
commit 605eac2
Showing
26 changed files
with
193 additions
and
28 deletions.
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
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,9 @@ | ||
extends: sequence | ||
message: "Use %[1]s-%[2]s %[3]s, as %[1]s-%[2]s is an adjective here." | ||
link: 'https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Usagedictionary' | ||
level: error | ||
ignorecase: true | ||
tokens: | ||
- pattern: '(?:back|front)' | ||
- pattern: 'end' | ||
- tag: NN |
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,8 @@ | ||
extends: sequence | ||
message: "Hyphenate %[1]s, as %[1]s is an adjective here." | ||
link: 'https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Usagedictionary' | ||
level: error | ||
ignorecase: true | ||
tokens: | ||
- pattern: '(?:backend|frontend)' | ||
- tag: NN |
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,17 @@ | ||
extends: substitution | ||
message: "Avoid device-specific language. Use '%s' instead of '%s'." | ||
link: 'https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Deviceagnosticism' | ||
level: error | ||
ignorecase: true | ||
action: | ||
name: replace | ||
swap: | ||
'click': select | ||
'choose': select | ||
'hit': select | ||
'long press': If there are multiple ways a user can interact with a touch screen, use an input-agnostic term like "select and hold". | ||
'pinch': If there are multiple ways a user can interact with a touch screen, use an input-agnostic term like "zoom out". | ||
'press': select | ||
'spread': If there are multiple ways a user can interact with a touch screen, use an input-agnostic term like "zoom in". | ||
'tap': If there are multiple ways a user can interact with a touch screen, use an input-agnostic term like "select". | ||
'(?<!agent |connection |data |device |event |file |issue |license |metric |monitor |resource |source )type(?! of)': Use "enter" to refer to the inputting of text. |
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 |
---|---|---|
@@ -1,11 +1,10 @@ | ||
extends: existence | ||
message: "Verify your use of '%s' with the Usage Dictionary." | ||
link: 'https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Usagedictionary' | ||
link: 'https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Overview#Writing' | ||
level: suggestion | ||
ignorecase: true | ||
tokens: | ||
- above | ||
- click | ||
- below | ||
- left | ||
- right |
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 |
---|---|---|
|
@@ -18,6 +18,7 @@ tokens: | |
- please | ||
- premium solutions | ||
- quite | ||
- realtime | ||
- recommend | ||
- recommended | ||
- remember | ||
|
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,8 @@ | ||
extends: sequence | ||
message: "Use drilldown as an adjective or noun." | ||
link: 'https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Usagedictionary' | ||
level: error | ||
ignorecase: true | ||
tokens: | ||
- tag: NN|JJ | ||
pattern: '(?:drill down|drill-down)' |
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,8 @@ | ||
extends: sequence | ||
message: "Use drill down as a verb." | ||
link: 'https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Usagedictionary' | ||
level: error | ||
ignorecase: true | ||
tokens: | ||
- tag: VB|VBD|VBG|VBN|VBP|VBZ | ||
pattern: '(?:drilldown|drill-down)' |
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,8 @@ | ||
extends: sequence | ||
message: "Use failover as an adjective or noun." | ||
link: 'https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Usagedictionary' | ||
level: error | ||
ignorecase: true | ||
tokens: | ||
- tag: NN|JJ | ||
pattern: '(?:fail-over|fail over)' |
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,8 @@ | ||
extends: sequence | ||
message: "Use fail over as a verb." | ||
link: 'https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Usagedictionary' | ||
level: error | ||
ignorecase: true | ||
tokens: | ||
- tag: VB|VBD|VBG|VBN|VBP|VBZ | ||
pattern: '(?:failover)' |
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
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,9 @@ | ||
extends: sequence | ||
message: "Don't use install as a noun or adjective. Use installation instead." | ||
link: 'https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Usagedictionary' | ||
level: error | ||
ignorecase: true | ||
nonword: false | ||
tokens: | ||
- tag: NN|NNP|NNPS|NNS|JJ|JJR|JJS | ||
pattern: 'install(?:\s|$)' |
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,6 @@ | ||
extends: sequence | ||
message: "Use log in as a verb. Don't use log on." | ||
ignorecase: true | ||
tokens: | ||
- tag: VB|VBD|VBG|VBN|VBP|VBZ | ||
pattern: '(?:log into|log in|login|log on)' |
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,8 @@ | ||
extends: sequence | ||
message: "Use lookup as an adjective or noun." | ||
link: 'https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Usagedictionary' | ||
level: error | ||
ignorecase: true | ||
tokens: | ||
- tag: NN|NNP|NNPS|NNS|JJR|JJ|JJS | ||
pattern: '(?:look-up|look up)' |
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,8 @@ | ||
extends: sequence | ||
message: "Use look up as a verb." | ||
link: 'https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Usagedictionary' | ||
level: error | ||
ignorecase: true | ||
tokens: | ||
- tag: VB|VBD|VBG|VBN|VBP|VBZ | ||
pattern: '(?:lookup)' |
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 | ||
message: 'Use a lowercase "x" in HTTP status codes and product version numbers.' | ||
link: https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Usagedictionary | ||
ignorecase: false | ||
level: error | ||
tokens: | ||
- '[0-9]+[X]+[X]' | ||
- '[0-9]+[X]+[x]' | ||
- '[0-9]+[x]+[X]' | ||
- '[0-9]+\.[0-9]+\.[X]' | ||
- '[0-9]+\.[X]' | ||
- '[0-9]+[0-9]+\.[X]' | ||
- '[0-9]+[0-9]+\.[0-9]+\.[X]' |
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,8 @@ | ||
extends: sequence | ||
message: "Use plugin as an adjective or noun." | ||
link: 'https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Usagedictionary' | ||
level: error | ||
ignorecase: true | ||
tokens: | ||
- tag: NN|JJ | ||
pattern: 'plug-in' |
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,8 @@ | ||
extends: sequence | ||
message: "Use plug in as a verb." | ||
link: 'https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Usagedictionary' | ||
level: error | ||
ignorecase: true | ||
tokens: | ||
- tag: VB|VBD|VBG|VBN|VBP|VBZ | ||
pattern: '(?:plug-in|plugin)' |
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,8 @@ | ||
extends: sequence | ||
message: "Use real-time %[3]s, as real-time is an adjective here." | ||
link: 'https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Usagedictionary' | ||
level: error | ||
tokens: | ||
- pattern: 'real' | ||
- pattern: 'time' | ||
- tag: NN |
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 |
---|---|---|
@@ -1,7 +1,7 @@ | ||
extends: existence | ||
message: 'Spell out "version" instead of abbreviating with a "v"' | ||
message: 'Spell out "version" instead of abbreviating with a "v".' | ||
link: https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Usagedictionary | ||
ignorecase: true | ||
level: error | ||
tokens: | ||
- '[v|V][0-9]+\.[0-9]+' | ||
- '[v|V][0-9]+\.[0-9]+' |
Oops, something went wrong.