Skip to content
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

doc: add docs for module.paths #14435

Closed
wants to merge 3 commits into from
Closed

doc: add docs for module.paths #14435

wants to merge 3 commits into from

Conversation

atever
Copy link
Contributor

@atever atever commented Jul 23, 2017 •
edited
Loading

Refs: #14371 (comment)

Checklist
Affected core subsystem(s)

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. module Issues and PRs related to the module subsystem. labels Jul 23, 2017
@vsemozhetbyt
Copy link
Contributor

Thank you!

Some suggestions:

  1. This should be placed before the bottom references part, alphabetically after "module.parent" chapter.
  2. Type should be {Array} (lowercase is for primitives).

@TimothyGu
Copy link
Member

Or even better, use {string[]} instead of {array} so that the inner type of the array is available as well.

@vsemozhetbyt
Copy link
Contributor

vsemozhetbyt commented Jul 23, 2017 •
edited
Loading

And maybe the "Refs:" line in the commit message need not be prefixed by "- ".

@atever
Copy link
Contributor Author

atever commented Jul 23, 2017

I will correct it, thx.

@atever
doc: correct the docs for module.paths
9adbe66 
Change the `module.paths` type to `string[]`.

According to alphabetical order, Move the `module.paths` after `module.parent`.

Refs: nodejs#14371 (comment)
@atever
Copy link
Contributor Author

atever commented Jul 23, 2017

Should I append Refs every commit, or just the first time?

@vsemozhetbyt
Copy link
Contributor

@atever Fixing follow up commits will be squashed, so the first time suffices.

vsemozhetbyt
vsemozhetbyt reviewed Jul 23, 2017
View reviewed changes
doc/api/modules.md
[native addons]: addons.html
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt Jul 23, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

cc @nodejs/documentation
This diff appears because we did not have a line break in this last line previously. Maybe it is worth to set some rule for this when doc linting is landed.

@atever
Copy link
Contributor Author

atever commented Jul 23, 2017

@vsemozhetbyt got it, thx.

@atever
doc: remove excess empty lines
cbbcf3b 
Remove excess empty lines
@vsemozhetbyt
Copy link
Contributor

@atever I think the line break after the addons.html should be added, but no other line break after that, yes. Sorry)

XadillaX
XadillaX approved these changes Jul 23, 2017
View reviewed changes
Copy link
Contributor

@XadillaX XadillaX left a comment

Choose a reason for hiding this comment

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

I think you can remove the [WIP] tag now.

@atever atever changed the title [WIP] doc: add docs for module.paths doc: add docs for module.paths Jul 23, 2017
@atever
Copy link
Contributor Author

atever commented Jul 23, 2017

Gained a lot, thanks for your patience. 😊

jasnell
jasnell reviewed Jul 24, 2017
View reviewed changes
doc/api/modules.md

* {string[]}

The search paths for the module.
Copy link
Member

Choose a reason for hiding this comment

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

This is a bit terse. Perhaps expand the explanation just a bit?

Copy link
Contributor

@refack refack Jul 25, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

I agree that a few more words should be added. Maybe also a link to the parts about module resolution.
@atever would you like to submit another PR?

refack pushed a commit that referenced this pull request Jul 25, 2017
@atever @refack
doc: add docs for module.paths
9ab3172 
PR-URL: #14435
Refs: #14371 (comment)
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
@refack
Copy link
Contributor

refack commented Jul 25, 2017

Landed in 9ab3172
🎉 🎈
@atever congrats on getting a GitHub promotion, from:
image
to:
image

addaleax pushed a commit that referenced this pull request Jul 27, 2017
@atever @addaleax
doc: add docs for module.paths
ab9bc81 
PR-URL: #14435
Refs: #14371 (comment)
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
@TimothyGu TimothyGu mentioned this pull request Jul 31, 2017
Closed
@addaleax addaleax mentioned this pull request Aug 2, 2017
Merged
@lundibundi lundibundi mentioned this pull request Jun 6, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@refack refack refack approved these changes

@jasnell jasnell jasnell left review comments

@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes

@lpinca lpinca lpinca approved these changes

@cjihrig cjihrig cjihrig approved these changes

@XadillaX XadillaX XadillaX approved these changes

@tniessen tniessen tniessen approved these changes

@gibfahn gibfahn gibfahn approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. module Issues and PRs related to the module subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.