Skip to content

doc: minor clarification in modules api doc. #1983

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jun 16, 2015
Merged

doc: minor clarification in modules api doc. #1983

merged 1 commit into from
Jun 16, 2015

Conversation

@ChALkeR
Copy link
Member

@ChALkeR ChALkeR commented Jun 15, 2015

This one is trivial. I noticed it while reading the modules API documentation.

@ChALkeR ChALkeR added the doc Issues and PRs related to the documentations. label Jun 15, 2015
@Fishrock123
Copy link
Contributor

Fishrock123 commented Jun 15, 2015

Mostly LGTM, but the proper language might be "relative path (i.e. /, ./, ../, etc)", since .. and . do also work.

Trott
Trott reviewed Jun 15, 2015
View reviewed changes
doc/api/modules.markdown Outdated
Copy link
Member

@Trott Trott Jun 15, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

@ChALkeR ChALkeR Jun 15, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@ChALkeR
Copy link
Member Author

ChALkeR commented Jun 15, 2015

@Fishrock123 foo/bar might also be a relative path, but that's not relevant. It needs a better description then, possibly listing all corner cases.

But documenting .. and . requires changes in many places all over the modules API doc. Is that needed? Examples: modules.markdown#all-together, modules.markdown#loading-from-node_modules-folders

The purpose of this is to make the documentation at least consistent.

@Fishrock123
Copy link
Contributor

Fishrock123 commented Jun 15, 2015

Yeah. LGTM.

@trevnorris
Copy link
Contributor

trevnorris commented Jun 16, 2015

LGTM

@ChALkeR
doc: minor clarification in the modules API doc.
96165f9 
PR-URL: nodejs#1983
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Ben Noordhuis <[email protected]>
@ChALkeR ChALkeR merged commit 96165f9 into nodejs:master Jun 16, 2015
@ChALkeR ChALkeR deleted the modules-doc branch June 16, 2015 02:45
@rvagg rvagg mentioned this pull request Jun 16, 2015
Closed
This was referenced Apr 24, 2023
Open
Open
This was referenced Jun 21, 2023
Open
Open
@gr00nd gr00nd mentioned this pull request Feb 6, 2024
Open
@aliscco aliscco mentioned this pull request Mar 29, 2024
Open
@leonardoadame leonardoadame mentioned this pull request Apr 6, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

doc Issues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@ChALkeR @Fishrock123 @trevnorris @Trott