Releases: splunk/vale-splunk-style-guide
1.9.3
1.9.2
Full Changelog: 1.9.1...1.9.2
Version 1.9.1
What's Changed
- Update SplunkProducts.yml by @wordsmeanstuff in #110
- Update and rename Numbers.yml to Third-party.yml by @wordsmeanstuff in #111
- Create Numbers.yml by @wordsmeanstuff in #113
- Create NumberAtStartOfSentence.yml by @wordsmeanstuff in #114
- Update UserFocus.yml by @wordsmeanstuff in #115
- Update Version.yml by @wordsmeanstuff in #72
- Create LatinEtc.yml by @wordsmeanstuff in #116
- Fixing broken links in README.md by @cgales in #117
- Update DontUse.yml to remove "remember" by @erica-splunk in #118
- Update WordList.yml by @erica-splunk in #119
New Contributors
Full Changelog: 1.9...1.9.1
Version 1.9
What's Changed
In this release, @wordsmeanstuff updated three main things:
- Updated alert levels in most yaml files so that minor rules won't break pipelines (if we go the automated route in the future).
- Split up a number of rules to keep some as
errors
but classify most others aswarnings
. - Renamed files for clarity and updated a few messages that authoring tools flash.
- Update WordList.yml by @theletterf in #31
- Update LoginVerb.yml by @wordsmeanstuff in #32
- Update DontUse.yml by @wordsmeanstuff in #33
- Update WordList.yml by @wordsmeanstuff in #34
- Update WordList.yml by @wordsmeanstuff in #35
- Update Acronyms.yml by @wordsmeanstuff in #36
- Update Adverbs.yml by @wordsmeanstuff in #37
- Update Ampersand.yml by @wordsmeanstuff in #39
- Update Acronyms.yml by @wordsmeanstuff in #40
- Update Adverbs.yml by @wordsmeanstuff in #41
- Update Acronyms.yml by @wordsmeanstuff in #42
- Update Adverbs.yml by @wordsmeanstuff in #43
- Update Ampersand.yml by @wordsmeanstuff in #44
- Update Inclusivity.yml by @wordsmeanstuff in #45
- Update and rename Failover.yml to FailoverAdjN.yml by @wordsmeanstuff in #46
- Delete styles/Splunk/LoginVerb.yml by @wordsmeanstuff in #47
- Delete styles/Splunk/Adverbs.yml by @wordsmeanstuff in #48
- Update Latin.yml by @wordsmeanstuff in #49
- Update Acronyms.yml by @wordsmeanstuff in #50
- Update Ampersand.yml by @wordsmeanstuff in #51
- Rename Drilldown.yml to DrilldownAdjN.yml by @wordsmeanstuff in #52
- Update FailoverVerb.yml by @wordsmeanstuff in #53
- Update and rename Lookup.yml to LookupAdjN.yml by @wordsmeanstuff in #54
- Update LookupVerb.yml by @wordsmeanstuff in #55
- Update and rename Plugin.yml to PluginAdjN.yml by @wordsmeanstuff in #56
- Update PluginVerb.yml by @wordsmeanstuff in #57
- Update and rename Backend-Frontend-Adjective.yml to BackendFrontendAd… by @wordsmeanstuff in #58
- Update and rename Backend-Frontend-Noun.yml to BackendFrontendN.yml by @wordsmeanstuff in #59
- Delete styles/Splunk/BackendFrontendAdj.yml by @wordsmeanstuff in #60
- Rename BackendFrontendN.yml to BackendFrontendAdj.yml by @wordsmeanstuff in #61
- Update DontUse.yml by @wordsmeanstuff in #62
- Update and rename Directional.yml to DirectionalLanguage.yml by @wordsmeanstuff in #63
- Update HeadingCapitalization.yml by @wordsmeanstuff in #64
- Rename Headings.yml to HeadingCapitalization.yml by @wordsmeanstuff in #65
- Update Hyphenation.yml by @wordsmeanstuff in #66
- Update HeadingPunctuation.yml by @wordsmeanstuff in #67
- Create SplunkProducts by @wordsmeanstuff in #68
- Rename SplunkProducts to SplunkProducts.yml by @wordsmeanstuff in #69
- Update WordList.yml by @wordsmeanstuff in #70
- Update WordList.yml by @wordsmeanstuff in #71
- Update TimeFormat.yml by @wordsmeanstuff in #73
- Update DataSingular.yml by @wordsmeanstuff in #74
- Update Dates.yml by @wordsmeanstuff in #75
- Update DeviceAgnosticism.yml by @wordsmeanstuff in #76
- Update DrilldownVerb.yml by @wordsmeanstuff in #77
- Update and rename Exclamation.yml to ExclamationPoints.yml by @wordsmeanstuff in #78
- Update Fractions.yml by @wordsmeanstuff in #79
- Update and rename Inclusivity.yml to InclusiveLanguage.yml by @wordsmeanstuff in #81
- Create Enable.yml by @wordsmeanstuff in #82
- Rename Install.yml to InstallAdjN.yml by @wordsmeanstuff in #84
- Update InstallAdjN.yml by @wordsmeanstuff in #85
- Update and rename Keyboardshortcuts.yml to KeyboardShortcuts.yml by @wordsmeanstuff in #86
- Update LowercaseX.yml by @wordsmeanstuff in #87
- Update Time.yml by @wordsmeanstuff in #88
- Create UnbiasedLanguage.yml by @wordsmeanstuff in #80
- Update Measurement.yml by @wordsmeanstuff in #89
- Update KeyboardShortcuts.yml by @wordsmeanstuff in #91
- Update and rename Parens.yml to Parentheses.yml by @wordsmeanstuff in #92
- Update Parentheses.yml by @wordsmeanstuff in #94
- Update and rename Periods.yml to PeriodsInAcronyms.yml by @wordsmeanstuff in #95
- Update PhoneNumbers.yml by @wordsmeanstuff in #96
- Update Possessives.yml by @wordsmeanstuff in #97
- Rename ProductTerms.yml to ProductTerminology.yml by @wordsmeanstuff in #98
- Update QuotesPunctuation.yml by @wordsmeanstuff in #99
- Update QuotesTypes.yml by @wordsmeanstuff in #100
- Update Ranges.yml by @wordsmeanstuff in #101
- Update Realtime.yml by @wordsmeanstuff in #102
- Update Recommendations.yml by @wordsmeanstuff in #103
- Update Repetition.yml by @wordsmeanstuff in #104
- Update RightAngleBracket.yml by @wordsmeanstuff in #105
- Update Semicolon.yml by @wordsmeanstuff in #106
- Update SentenceSpacing.yml by @wordsmeanstuff in #107
- Update and rename Subjunctive.yml to SubjunctiveMood.yml by @wordsmeanstuff in #108
- Create Stack.yml by @wordsmeanstuff in #109
Full Changelog: 1.8.1...1.9
1.8.1
-
For numbers, we ended up deleting the rule that flags numbers appearing in units of time, since we always want those to be numerals anyway. @wordsmeanstuff filed a pull request for this with additional explanation in #28
-
@erica-splunk removed “specify” from the word list in this commit.
-
@erica-splunk made several changes in #30, adding “Splunk Observability Cloud platform” to the
WordList
rule and moving the original rule flagging definite articles with product terms to a new rule with revised guidance. -
Added
error
andservice
as an exception for thetype
pattern inDeviceAgnosticism
, so that "error type" orservice type
don't trigger a warning. In the future, we could consider using a sequence pattern so that we only flag type when it's a verb. -
Added
and|or
to theVersion
rule so that it triggers only in the context of versions:'(?:and|or) later': higher for software versions
(same forearlier
). -
Clarified the “switch vs toggle” message so that it reads like in the Usage dictionary:
Use as a verb to move a switch component back and forth between on and off states. Don't call a switch component a "toggle."
. -
Added a comma in the
refer to
pattern so that it only triggers where we would typically say it instead of the simplersee
. -
Fixed a bug detected by @auburnwil — thanks!
Big thanks to @bhillmer for reporting all the above issues!
1.7.0
- Added rules for keyboard shortcuts and related abbreviations.
- Fixed some bugs.
1.6.0
1.5.0
- Updated
Inclusivity.yml
with new rules forenable|enabled
anddisable|disabled
.
1.4.3
Fix formatting issues in WordList.yml
1.4.2
Removed test text from README.