doc: minor clarification in modules api doc. #1983
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
|
Mostly LGTM, but the proper language might be "relative path (i.e. |
| @@ -145,7 +145,7 @@ A module prefixed with `'./'` is relative to the file calling `require()`. | |||
| That is, `circle.js` must be in the same directory as `foo.js` for | |||
| `require('./circle')` to find it. | |||
|
|
|||
| Without a leading '/' or './' to indicate a file, the module is either a | |||
| Without a leading '/', './', or '../' to indicate a file, the module is either a | |||
| "core module" or is loaded from a `node_modules` folder. | |||
There was a problem hiding this comment.
Unrelated-but-nearby nit: If you're feeling like it, "core module" in the next line should really just be core module without any quotation marks.
|
@Fishrock123 But documenting The purpose of this is to make the documentation at least consistent. |
|
Yeah. LGTM. |
|
LGTM |
PR-URL: nodejs#1983 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
This was referenced Apr 24, 2023
This was referenced Jun 21, 2023
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.
This one is trivial. I noticed it while reading the
modulesAPI documentation.