Skip to content

Commit 6ad3ce1

Browse files
authored
Style Guide: Fix two-letter acronym
The old text was based on what was in the [Dart guideline](https://dart.dev/guides/language/effective-dart/style#do-capitalize-acronyms-and-abbreviations-longer-than-two-letters-like-words) and was not adjusted in the PR when we changed our inspiration to be the [.NET guideline](https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/capitalization-conventions) -- (it was only changed in the examples in our internal discussion)
1 parent 9721182 commit 6ad3ce1

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/ql-style-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ private predicate foo(Expr e, Expr p) {
173173
1. Use [camelCase](https://en.wikipedia.org/wiki/Camel_case) for:
174174
- Predicate names
175175
- Variable names
176-
1. Acronyms *should* use normal PascalCase/camelCase (as an exception, if there are only two letters then using all uppercase letters is acceptable).
176+
1. Acronyms *should* use normal PascalCase/camelCase. However, two-letter acronyms should have both letters capitalized.
177177
1. Newtype predicate names *should* begin with `T`.
178178
1. Predicates that have a result *should* be named `get...`
179179
1. Predicates that can return multiple results *should* be named `getA...` or `getAn...`

0 commit comments

Comments
 (0)