fix: correct JSDoc parameter description in blake512FromPath#366
Open
Lil-Duckling-22 wants to merge 1 commit into
Open
fix: correct JSDoc parameter description in blake512FromPath#366Lil-Duckling-22 wants to merge 1 commit into
Lil-Duckling-22 wants to merge 1 commit into
Conversation
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
1 participant
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.
Motivation
The JSDoc comment for blake512FromPath incorrectly described the parameter as "data buffer or hexadecimal string", while the function accepts a file path (fs.PathLike). This mismatch could mislead developers using the function.
Solution
Updated the JSDoc parameter description to match the function signature: changed @param data buffer or hexadecimal string to @param path <fs.PathLike> - path to the file to hash. The documentation now accurately reflects the function's implementation and usage throughout the codebase.