Do not scan uncommentable files #825
Merged
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
|
This PR seems good. I did some light tweaking. I especially liked renaming the function from I'm not entirely certain this won't have undesired effects. I'm going to approve the PR, and I'll merge it after discussing with some other peeps. Thanks a lot @hoijui ! |
carmenbianca
approved these changes
Sep 23, 2023
|
thank you for these comments @carmenbianca, and the improvements! |
|
Did an in-person review together with @nicorikken. Let's merge this! (after fixing some merge conflicts) |
Also renames `_is_uncommentable` to `_is_commentable`, to prevent needless double (and triple) negations, which makes code harder to understand.
This prevents incidents of e.g. falsely detected copyright info in e.g. binary files, if they contain the word "Copyright" as plain-text. This happened to me in the case of some JPG files, for example. This also saves us from reading binary file contents unnecessarily.
|
Wooho, thanks! :-) |
This was referenced Jan 19, 2024
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.
This prevents incidents of falsely detected copyright info
in binary files (and other uncommentable file types),
if they contain the word "Copyright" as plain-text.
This happened to me in the case of some JPG files, for example.
This also saves us from reading binary file contents unnecessarily.
... or are there ever cases where we want to detect plain-text in binary or uncommentable files?