hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-04-29 18:55:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

address review comment about sentence style

Browse Source
This commit is contained in:
james
2020-06-22 17:07:10 +01:00
parent 676d486635
commit 3fa49a9771
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/qldoc-style-guide.md
View File

@@ -18,8 +18,8 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
### Language requirements
1. Use US English.
1. Use full sentences, with capital letters and full stops, except for the initial sentence of the comment, which may be fragmentary as described below.
1. Use American English.
1. Use full sentences, with capital letters and periods, except for the initial sentence of the comment, which may be fragmentary as described below.
1. Use simple sentence structures and avoid complex or academic language.
1. Avoid colloquialisms and contractions.
1. Use words that are in common usage.