Skip to content

Commit 84daa99

Browse files
authored
Add Good/Bad edge case examples to R3016 (Azure#15043)
From https://docs.microsoft.com/en-us/previous-versions/dotnet/netframework-1.1/141e06ef(v=vs.71)?redirectedfrom=MSDN: > When using acronyms, use Pascal case or camel case for acronyms more than two characters long and > However, you should capitalize acronyms that consist of only two characters, such as System.IO instead of System.Io.
1 parent 2fb369b commit 84daa99

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

documentation/openapi-authoring-automated-guidelines.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,15 +237,19 @@ For more capitalization guidance, see: [https://msdn.microsoft.com/en-us/library
237237
* fooBarBaz
238238
* resourceKey
239239
* resourceApiKey
240+
* publicIPAddress
241+
* enableSsl
240242

241243
**Bad Examples**: The following would be invalid:
242244
* PascalCase
243245
* UpperCamelCase
244246
* resourceAPIKey
247+
* enableSSL
245248

246249
**Bad Examples**: The following violate these guidelines but would not be caught by automation:
247250
* alllowercase - If there are multiple words, please capitalize starting with the second word
248251
* miXeDcApItAlIzAtIoN - Please capitalize the first letter of each word (and not seemingly random letters)
252+
* resourceAPIkey - Automation would incorrectly recognize "Ikey" as a word and not flag the property name
249253

250254
Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings)
251255

0 commit comments

Comments
 (0)