Skip to content

Commit 1ecee2d

Browse files
authored
Merge pull request github#5357 from yoff/python-rework-documentation
Python: rework documentation
2 parents 05779ef + 0fc3099 commit 1ecee2d

10 files changed

+422
-637
lines changed

.vscode/settings.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
22
"omnisharp.autoStart": false
3-
}
3+
}

docs/codeql/codeql-language-guides/analyzing-control-flow-in-python.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To show why this complex relation is required consider the following Python code
2626
finally:
2727
close_resource()
2828
29-
There are many paths through the above code. There are three different paths through the call to ``close_resource();`` one normal path, one path that breaks out of the loop, and one path where an exception is raised by ``might_raise()``.
29+
There are many paths through the above code. There are three different paths through the call to ``close_resource();`` one normal path, one path that breaks out of the loop, and one path where an exception is raised by ``might_raise()``.
3030

3131
An annotated flow graph:
3232

@@ -114,11 +114,10 @@ Example finding mutually exclusive blocks within the same function
114114
)
115115
select b1, b2
116116
117-
➤ `See this in the query console on LGTM.com <https://lgtm.com/query/671000028/>`__. This typically gives a very large number of results, because it is a common occurrence in normal control flow. It is, however, an example of the sort of control-flow analysis that is possible. Control-flow analyses such as this are an important aid to data flow analysis. For more information, see ":doc:`Analyzing data flow and tracking tainted data in Python <analyzing-data-flow-and-tracking-tainted-data-in-python>`."
117+
➤ `See this in the query console on LGTM.com <https://lgtm.com/query/671000028/>`__. This typically gives a very large number of results, because it is a common occurrence in normal control flow. It is, however, an example of the sort of control-flow analysis that is possible. Control-flow analyses such as this are an important aid to data flow analysis. For more information, see ":doc:`Analyzing data flow in Python <analyzing-data-flow-in-python>`."
118118

119119
Further reading
120120
---------------
121121

122122
.. include:: ../reusables/python-further-reading.rst
123123
.. include:: ../reusables/codeql-ref-tools-further-reading.rst
124-

docs/codeql/codeql-language-guides/analyzing-data-flow-and-tracking-tainted-data-in-python.rst

Lines changed: 0 additions & 269 deletions
This file was deleted.

0 commit comments

Comments
 (0)