Skip to content

Commit 9d4cc1e

Browse files
committed
Improve README
1 parent a89eced commit 9d4cc1e

File tree

1 file changed

+37
-2
lines changed

1 file changed

+37
-2
lines changed

README.rst

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,44 @@
22
CodeQL evaluations
33
##################
44

5+
56
*****
67
About
78
*****
89

9-
Running CodeQL scans on some Python code snippets, in order to evaluate some
10-
features and outcomes.
10+
Running CodeQL scans on a few Python code snippets, in order to evaluate some
11+
features and outcomes, and discover eventual false positives.
12+
13+
14+
*******
15+
Details
16+
*******
17+
18+
There are two Python code examples, which will produce false positives on CodeQL scans.
19+
They are about those rules, more details can be found within the corresponding example
20+
programs.
21+
22+
- ``py/call-to-non-callable``
23+
- ``py/unused-local-variable``
24+
25+
26+
********
27+
Synopsis
28+
********
29+
30+
Setup
31+
=====
32+
::
33+
34+
python3 -m venv .venv
35+
source .venv/bin/activate
36+
pip install pytest crate[sqlalchemy]
37+
docker run --rm -it --publish=4200:4200 crate:5.1.1
38+
39+
Run tests
40+
=========
41+
::
42+
43+
source .venv/bin/activate
44+
pytest
45+

0 commit comments

Comments
 (0)