Improve comments on app engine imports and add docs - #5449
Merged
Conversation
dylanjew
reviewed
Sep 3, 2026
dylanjew
reviewed
Sep 3, 2026
dylanjew
left a comment
dylanjew
left a comment
Collaborator
There was a problem hiding this comment.
LGTM, pending comments.
This only changes documentation so is safe to merge, but will add @ViniciustCosta for visibility
| """ | ||
| if self._fuzz_targets is None: | ||
| # Import here as this path is not available in App Engine context. | ||
| # IMPORTANT: `clusterfuzz._internal.bot` has to be imported locally since |
Collaborator
There was a problem hiding this comment.
Tbh I'm not a big fan of the "IMPORTANT", I think the comment right above the import is pretty clear, now with the link to the doc for rationale.
Collaborator
There was a problem hiding this comment.
I'm not a huge fan of it either, but if we're relying on comments to enforce correctness rather than tests I thought it might help it stand out.
I'm ok with keeping the previous text with the link
ViniciustCosta
approved these changes
Sep 8, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Document developer pitfalls on App Engine imports and update comments to be clearer to be clearer on what and why it has to be imported locally.
b/552964079