Rasmus Wriedt Larsen
|
9f2d89c903
|
Update ql-style-guide.md
Our [QLDoc style guide](https://github.com/github/codeql/blob/main/docs/qldoc-style-guide.md#predicates-with-result) says that we should avoid any use of `return`, so it would be smart to also do so in our own style guide for predicate names 😊
|
2022-11-16 15:27:38 +01:00 |
Marcono1234
|
ab90fe18fd
|
Docs: Use GitHub links for guides, improve formatting
|
2021-05-04 12:35:23 +02:00 |
Rasmus Wriedt Larsen
|
6ad3ce19d7
|
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)
|
2021-02-19 11:51:45 +01:00 |
Rasmus Wriedt Larsen
|
779a464dad
|
Update ql-style-guide.md to not mention abbreviation
This rule is only really intended for acronyms, and not abbreviations in general (like `Stmt` instead of `Statement`).
|
2021-02-18 17:54:59 +01:00 |
Rasmus Wriedt Larsen
|
12511440fe
|
Update ql-style-guide.md
Replacing the HTTP example with a SSA variable example. I didn't want to keep both, to not bloat this section.
|
2021-02-18 17:52:24 +01:00 |
Rasmus Wriedt Larsen
|
1de3524bc5
|
Update docs/ql-style-guide.md
Co-authored-by: Jonas Jensen <jbj@github.com>
|
2021-02-04 12:27:38 +01:00 |
Rasmus Wriedt Larsen
|
2453a25833
|
Update docs/ql-style-guide.md
Co-authored-by: Anders Schack-Mulligen <aschackmull@users.noreply.github.com>
|
2021-02-03 13:42:08 +01:00 |
Rasmus Wriedt Larsen
|
0ea7aa54f9
|
Update CodeQL Style guide to mention acronyms
Adding this after asking how to do this internally. Is based on https://dart.dev/guides/language/effective-dart/style#do-capitalize-acronyms-and-abbreviations-longer-than-two-letters-like-words
|
2021-02-03 13:31:26 +01:00 |
James Fletcher
|
5ebaa1d303
|
Apply suggestions from code review
Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>
|
2020-06-22 12:07:42 +01:00 |
james
|
f02b54fcd2
|
docs: add more detailed qldoc style guide
|
2020-06-19 15:59:22 +01:00 |
Shati Patel
|
bdfb8a337e
|
Update style guides with premigration changes
|
2020-05-26 11:08:11 +01:00 |
Shati Patel
|
7a4b6a62d7
|
Update outdated links
|
2020-04-28 11:52:49 +01:00 |
Shati Patel
|
1ff5a8e8e2
|
Docs: Update references to QL for Eclipse
|
2019-12-16 12:28:39 +00:00 |
Felicity Chapman
|
570e55190d
|
Update style guides for name change
|
2019-11-01 12:22:05 +00:00 |
Shati Patel
|
b6311836a0
|
Docs: small fixes
|
2019-10-10 15:50:50 +01:00 |
james
|
7ec2c05796
|
docs: address review comments and fix a few other things
|
2019-08-05 15:40:41 +01:00 |
Anders Schack-Mulligen
|
268de8de4f
|
Style guide: Fix whitespace.
|
2018-11-07 09:12:55 +01:00 |
Anders Schack-Mulligen
|
99846474eb
|
QL style guide: Adjust style rules for if-then-else.
|
2018-10-10 16:42:34 +02:00 |
Anders Schack-Mulligen
|
31e1706c98
|
QL style guide: Address some review comments.
|
2018-10-10 16:42:34 +02:00 |
Anders Schack-Mulligen
|
6feb1d0766
|
QL style guide: Clarify some outstanding issues.
|
2018-10-10 16:42:34 +02:00 |
Dave Bartolomeo
|
26abf5d4a2
|
Force LF for basically everything.
|
2018-09-23 16:24:31 -07:00 |
shati-semmle
|
4965377283
|
QL style guide: Small fixes
- Don't suggest new line after `deprecated`
- Add a missing backtick
|
2018-08-23 15:15:47 +01:00 |
calum
|
529dbe08c8
|
Address review comments. Reformat bullet lists with capitals and remove trailing punctuation.
|
2018-08-20 11:00:35 +01:00 |
calumgrant
|
c2ad56adce
|
Fix table format
|
2018-08-17 18:15:02 +01:00 |
calum
|
2a66585028
|
Address some review comments, apart from the bullet format.
|
2018-08-17 18:12:08 +01:00 |
calum
|
68d8b66a1f
|
Minor edits.
|
2018-08-16 14:01:31 +01:00 |
calum
|
72e690764e
|
Add the QL Style Guide.
|
2018-08-16 13:23:01 +01:00 |