Improve wording of isAdditionalFlow/TaintStep qldoc #8638
Conversation
cpp/ql/lib/semmle/code/cpp/dataflow/internal/tainttracking1/TaintTrackingImpl.qll
Outdated
Show resolved
Hide resolved
| * Holds if the additional flow step from `node1` to `node2` must be taken | ||
| * into account in the analysis. | ||
| * Holds if the analysis should assume that data may flow from `node1` to `node2` | ||
| * in addition to the normal dataflow steps. | ||
| */ | ||
| predicate isAdditionalFlowStep(Node node1, Node node2) { none() } |
There was a problem hiding this comment.
This is a rather long way of phrasing "data may flow from node1 to node2". Would it be equally clear to just write:
Holds if data may flow from
node1tonode2in addition to the normal dataflow steps.
?
There was a problem hiding this comment.
nit: I believe we tend to write data-flow steps instead of dataflow steps.
There was a problem hiding this comment.
~400 matches for dataflow (including spaces, case-sensitive) and ~800 for data-flow, so I've gone with the majority but we're far from consistent
|
@jketema @MathiasVP taken both suggestions |
|
While this is being changed, would it make sense to rename the parameters to something more intuitive/descriptive? |
|
@jketema please re-approve |
@Marcono1234 at #8616 asked that we avoid using
mustwith the possible implication that this is a mandatory "waypoint" / "via" step, rather than an additional step that may or may not be used in a given path.