chore(index): add inline comment for short file check#600
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds clarifying inline documentation around the existing “short file” guard in UnRTF.convert() so the intent of the RTF magic-number check is easier to understand when revisiting the logic introduced in #598.
Changes:
- Adds an inline comment above the
bytesRead/magic-number check inconvert().
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Short file check was added in #598 but could do with an inline comment so when I revisit it I know what the heck I was thinking!
Checklist
npm test