Merge pull request #5080 from github/RasmusWL/naming-for-acronyms

aschackmull · web-flow · commit 97211825238c · 2021-02-19T11:38:25.000+01:00
Update CodeQL Style guide to mention acronyms
diff --git a/docs/ql-style-guide.md b/docs/ql-style-guide.md
@@ -173,6 +173,7 @@ private predicate foo(Expr e, Expr p) {
 1. Use [camelCase](https://en.wikipedia.org/wiki/Camel_case) for:
    - Predicate names
    - Variable names
+1. Acronyms *should* use normal PascalCase/camelCase (as an exception, if there are only two letters then using all uppercase letters is acceptable).
 1. Newtype predicate names *should* begin with `T`.
 1. Predicates that have a result *should* be named `get...`
 1. Predicates that can return multiple results *should* be named `getA...` or `getAn...`
@@ -183,6 +184,7 @@ private predicate foo(Expr e, Expr p) {
 1. Use names as they are used in the target-language specification.
 1. Use American English.
 
+
 ### Examples
 
 ```ql
@@ -209,6 +211,9 @@ class Type extends ... {
 
   /** ... */
   Type getATypeParameter() { ... }
+  
+  /** Gets the SSA variable ... */
+  predicate getSsaVariable() { ... }
 }
 ```
 
