From dbf7487a9b300175cff605ebc930752993fbed1e Mon Sep 17 00:00:00 2001 From: james Date: Mon, 23 Aug 2021 11:34:48 +0100 Subject: [PATCH] address review comments --- docs/codeql/writing-codeql-queries/codeql-queries.rst | 2 +- .../debugging-data-flow-queries-using-partial-flow.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/codeql/writing-codeql-queries/codeql-queries.rst b/docs/codeql/writing-codeql-queries/codeql-queries.rst index 7a31fc76296..9607e782355 100644 --- a/docs/codeql/writing-codeql-queries/codeql-queries.rst +++ b/docs/codeql/writing-codeql-queries/codeql-queries.rst @@ -26,4 +26,4 @@ CodeQL queries are used in code scanning analyses to find problems in source cod - :doc:`About data flow analysis `: Data flow analysis is used to compute the possible values that a variable can hold at various points in a program, determining how those values propagate through the program and where they are used. - :doc:`Creating path queries `: You can create path queries to visualize the flow of information through a codebase. - :doc:`Troubleshooting query performance `: Improve the performance of your CodeQL queries by following a few simple guidelines. -- :doc:`Debugging data-flow queries using partial flow `: If a data-flow query unexpectedly produces no results, you can use partial flow to debug the problem. +- :doc:`Debugging data-flow queries using partial flow `: If a data-flow query doesn't produce the results you expect to see, you can use partial flow to debug the problem.. diff --git a/docs/codeql/writing-codeql-queries/debugging-data-flow-queries-using-partial-flow.rst b/docs/codeql/writing-codeql-queries/debugging-data-flow-queries-using-partial-flow.rst index c74b6bb635e..afbd741e822 100644 --- a/docs/codeql/writing-codeql-queries/debugging-data-flow-queries-using-partial-flow.rst +++ b/docs/codeql/writing-codeql-queries/debugging-data-flow-queries-using-partial-flow.rst @@ -3,7 +3,7 @@ Debugging data-flow queries using partial flow ============================================== -If a data-flow query unexpectedly produces no results, you can use partial flow to debug the problem. +If a data-flow query doesn't produce the results you expect to see, you can use partial flow to debug the problem. In CodeQL, you can use :ref:`data flow analysis ` to compute the possible values that a variable can hold at various points in a program. A typical data-flow query looks like this: @@ -32,7 +32,7 @@ Or slightly simpler without path explanations: where config.hasPath(source, sink) select sink, "Sink is reached from $@.", source.getNode(), "here" -If a data-flow query that you have written does not produce any results when you expect it to, there may be a problem with your query. +If a data-flow query that you have written doesn't produce the results you expect it to, there may be a problem with your query. You can try to debug the potential problem by following the steps described below. Checking sources and sinks