Freshen levee package docs #220
Conversation
mlevesquedion
requested review from
PurelyApplied,
benhxy and
vinayakankugoyal
| @@ -51,9 +57,6 @@ func Dfs(n ssa.Node, conf source.Classifier, taggedFields fieldtags.ResultType) | |||
| return record | |||
| } | |||
|
|
|||
| // dfs performs Depth-First-Search on the def-use graph of the input Source. | |||
There was a problem hiding this comment.
Why remove this comment? I think the second part of the comment was very useful for a newb like me. Did the behavior mentioned in the comment change?
There was a problem hiding this comment.
The last sentence is actually incorrect. When the traversal encounters a Sanitizer, it merely records that the sanitizer has been reached. Sanitizers are not otherwise treated differently from other calls.
Removing the comment is the wrong thing to do here, though. I have rewritten the comment instead, thank you for your input! WDYT about this new comment?
There was a problem hiding this comment.
LGTM! Thanks for adding great documentation to this method.
| @@ -51,9 +57,6 @@ func Dfs(n ssa.Node, conf source.Classifier, taggedFields fieldtags.ResultType) | |||
| return record | |||
| } | |||
|
|
|||
| // dfs performs Depth-First-Search on the def-use graph of the input Source. | |||
There was a problem hiding this comment.
LGTM! Thanks for adding great documentation to this method.
| // Dfs performs a depth-first search of the graph formed by SSA Referrers and | ||
| // Operands relationships. |
There was a problem hiding this comment.
Consider adding beginning at the root node n to the doc comment to distinguish this exported Dfs as the entrypoint for a given root vs the recursive step dfs below.
There was a problem hiding this comment.
Done. Thanks!
This PR aims to improve the documentation for the
leveeandpropagationpackages. Specifically, it adds a few documentation comments and removes/rectifies a few incorrect pieces of documentation.