Mention needed imports at top of "Analyzing data flow in Java" #13692
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently the guide just starts using the classes from these libraries without having mentioned that you have to import the libraries first.
|
Suggest moving these imports just inside the "Using local data flow" and "Using local taint tracking" sections. Seems reasonable to note the required import up front though. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently the guide just starts using the classes from these libraries without having mentioned that you have to import the libraries first.
This is rather inconvenient and I always end up scrolling down somewhere to the examples where the needed imports are used.
Any feedback is appreciated, especially regarding wording or position of this information in the document.
The guides for the other languages might benefit from this change as well, please let me know if I should change it there as well, though I am not familiar with the needed imports there. Or feel free to perform these changes yourself and push them onto the branch of this pull request.