chore: fix typos#570
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR performs small typo/formatting corrections in documentation and JSDoc, improving consistency of naming and generated docs without changing runtime behavior.
Changes:
- Fixes JSDoc
@returnsspacing/formatting inUnRTF#convert. - Fixes a README example typo to use the correct
unRtfinstance name.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/index.js | JSDoc formatting cleanup for the convert method return annotation. |
| README.md | Corrects the promise-chaining example to call .convert on unRtf (matching the variable declaration). |
💡 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.
Checklist
npm test