docs: improve README wording#55
Closed
Rohan5commit wants to merge 1 commit into
Closed
Conversation
There was a problem hiding this comment.
Pull request overview
This PR clarifies the README description of the .cancel() behavior on the promise returned by pEvent(), making it clearer that calling .cancel() leaves the promise pending rather than implying a different terminal state.
Changes:
- Update README wording from “never be settled” to “remain unsettled” for
.cancel()behavior.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Owner
|
No thanks |
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.
Summary
.cancel()behavior descriptionRelated issue
Guideline alignment
Validation