hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-05-01 03:35:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update ql-style-guide.md to not mention abbreviation

Browse Source 
This rule is only really intended for acronyms, and not abbreviations in general (like `Stmt` instead of `Statement`).
This commit is contained in:
Rasmus Wriedt Larsen
2021-02-18 17:54:59 +01:00
committed by GitHub
parent 12511440fe
commit 779a464dad
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/ql-style-guide.md
View File

@@ -173,7 +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. Abbreviations and acronyms *should* use normal PascalCase/camelCase (as an exception, if there are only two letters then using all uppercase letters is acceptable).
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...`