Fix usage instructions in README #113
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
Refs mathiasbynens#79 This change updates the usage instructions in the README to explain the workaround required to use this module. As userland modules do not hide core modules, a trailing slash is required to have Node.js use this module over the built-in.
1 task
mathiasbynens
approved these changes
Oct 23, 2020
|
Thanks! |
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.
Refs #79
This change updates the usage instructions in the README to explain the workaround required to use this module. As userland modules do not hide core modules, a trailing slash is required to have Node.js use this module over the built-in.
I copied the warning text from the
node/no-deprecated-apidocs.Note: I personally think this is confusing, but since this is the preferred workaround (per this comment) and this module is what the official Node.js docs recommend,[1] it is worth clarifying.