Skip to content

Commit 9f1097a

Browse files
Documentation fixes (typos, formatting, readme/contributing) (#5)
1 parent d29fa48 commit 9f1097a

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Contributing
22

3-
[fork]: https://github.com/github/REPO/fork
4-
[pr]: https://github.com/github/REPO/compare
3+
[fork]: https://github.com/advanced-security/codeql-qtil/fork
4+
[pr]: https://github.com/advanced-security/codeql-qtil/compare
55
[code-of-conduct]: CODE_OF_CONDUCT.md
66

77
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
@@ -30,7 +30,7 @@ The next step, after registering and discussing your improvement, is proposing t
3030
5. Ensure the files are appropriately formatted: QL files should be formatted with `codeql query format`.
3131
6. Create new tests for any new features or changes to existing features. Ensure all existing tests pass. Tests can be run with `codeql test run $DIR`, where `$DIR` is either `/test` in the repo root, or `$LANG/test` for a specific language.
3232
7. If relevant, ensure the change will be applied to all languages supported by qtil. Exceptions can be applied if necessary.
33-
8. Push to your fork and [submit a draft pull request](https://github.com/github/codeql-coding-standards/compare). Make sure to select **Create Draft Pull Request**.
33+
8. Push to your fork and [submit a draft pull request](https://github.com/advanced-security/codeql-qtil/compare). Make sure to select **Create Draft Pull Request**.
3434
9. Address failed checks, if any.
3535
10. Mark the [pull request ready for review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#marking-a-pull-request-as-ready-for-review).
3636
11. Pat your self on the back and wait for your pull request to be reviewed and merged.

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Let's dive in!
1313

1414
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE.txt) for the full terms.
1515

16-
CodeQL is subject to the [GithHub CodeQL Terms & Conditions](https://securitylab.github.com/tools/codeql/license).
16+
CodeQL is subject to the [GitHub CodeQL Terms & Conditions](https://securitylab.github.com/tools/codeql/license).
1717

1818
## Background
1919

@@ -49,7 +49,7 @@ To use `qtil`, you can either import everything at once, or pick what you need:
4949
import qtil.Qtil
5050
class MyPair extends Qtil::Pair<...> { ... }
5151
52-
// or import what you need with no namepsace
52+
// or import what you need with no namespace
5353
import qtil.tuple.Pair
5454
class MyPair extends Pair<...> { ... }
5555
```
@@ -135,7 +135,7 @@ class AgeOrderedCityPerson extends Qtil::Ordered<Person>::GroupBy<City>::Type {
135135
136136
// Selects people, along with the next youngest and next oldest in the same city.
137137
from AgeOrderedCityPerson p
138-
select p.getName(), p.getCity(), p.getPrevious.getName(), p.getNext.getName()
138+
select p.getName(), p.getCity(), p.getPrevious().getName(), p.getNext().getName()
139139
```
140140

141141
**CondensedList**: Like the `Ordered` class, but creates a separate `ListEntry` type rather than
@@ -183,8 +183,8 @@ select Qtil::Escape<Qtil::defaultEscapeMap/2>::escape("foo\\bar\nbaz"),
183183
select Qtil::doubleQuoteWrap("foo\"bar\\baz"), Qtil::unescapeDoubleQuote("\"foo\\\"bar\\\\baz\"")
184184
185185
// CSV-like functionality: result is "foo\\,bar,baz\\\\qux", "foo,bar"
186-
select Qtil::SeparatedEscape<Qtil::Chars::comma\0>::EscapeBackslash::of2("foo,bar", "baz\\qux"),
187-
Qtil::SeparatedEscape<Qtil::Chars::comma\0>::split("foo\\,bar,baz\\\\qux", Qtil::charOf("\\"), 0)
186+
select Qtil::SeparatedEscape<Qtil::Chars::comma/0>::EscapeBackslash::of2("foo,bar", "baz\\qux"),
187+
Qtil::SeparatedEscape<Qtil::Chars::comma/0>::split("foo\\,bar,baz\\\\qux", Qtil::charOf("\\"), 0)
188188
```
189189

190190
Escaping characters will carefully escape and unescape themselves. See documentation on escape maps
@@ -350,7 +350,7 @@ primitives) require special care, which `InfInstance` handles correctly, allowin
350350
some contexts, such as parameterized modules. Simply extend `Qtil::Final<T>::Type` instead of
351351
declaring a final alias type.
352352

353-
```
353+
```ql
354354
// Use CodeQL "final" extension:
355355
class MyFoo1 extends Qtil::Final<Foo>::Type { ... }
356356
@@ -464,7 +464,7 @@ fails, the result of each test will be selected (including failing and passing t
464464
For correct use, ensure that each test class passes with a unique name, and that tests always hold
465465
for some result, whether its a pass or a fail.
466466

467-
```
467+
```ql
468468
override predicate run(Qnit test) {
469469
if 1 = 1
470470
then test.pass("1 equals 1") // Ensure this is unique to the test
@@ -493,7 +493,7 @@ module MyModule<binary/2 binop> { ... }
493493

494494
This module allows you to write:
495495

496-
```
496+
```ql
497497
module MyModule<Qtil::Binary<int, int>::pred/2 binop> { ... }
498498
```
499499

@@ -563,5 +563,5 @@ receiving timely support amidst our busy jobs here at GitHub!
563563

564564
## Maintainers
565565

566-
This project is currently maintained by @michaelrfairhurst with help from other CodeQL/security
567-
experts at GitHub.
566+
This project is currently maintained by CodeQL/security/code quality experts. Support on any given
567+
day is likely to come from @michaelrfairhurst.

0 commit comments

Comments
 (0)