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.

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

Probably, some mistakes in the Node.js API documentation ("Modules" file) #27640

Closed
Alex-Temny opened this issue May 10, 2019 · 3 comments
Closed
Labels
doc Issues and PRs related to the documentations.

Comments

@Alex-Temny
Copy link
Contributor

Issues with the Node.js API documentation should be posted here.

Hi,
I translated Modules file recently (v6).
https://nodejs.org/docs/latest-v6.x/api/modules.html
It seems to me that something is a little bit strange with 2 sentences:

"Putting together all of the above, here is the high-level algorithm in pseudocode of what require.resolve() does:"

What was discussed above in the previous sections is mostly how require() works.
And in the pseudocode below the above sentence they write "require(X)...".

So, I guess the correct version should be
"Putting together all of the above, here is the high-level algorithm in pseudocode of what require() does:"

"It is convenient to organize programs and libraries into self-contained directories, and then provide a single entry point to that library."

As far as I understand, libraries and directories are different things.
So, if they organize programs and libraries into directories, then the entry point should probably be provided to directories.

So, I guess the correct version should be
"It is convenient to organize programs and libraries into self-contained directories, and then provide a single entry point to those directories."


I'm not a professional programmer, so maybe I got something wrong.
Please, look into this.

@sam-github
Copy link
Contributor

node 6.x is no longer supported, so I don't think we will fix its docs.

Are these issues present in master? If so, could you PR fixes?

@Alex-Temny
Copy link
Contributor Author

Alex-Temny commented May 10, 2019

As far as I understand, the master branch is about v. 12.2.0.
Yes, these 2 little issues are there too.
I'll try to make PR with fixes.

@mbj36
Copy link
Contributor

mbj36 commented Jun 5, 2019

I think this issue can be closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

No branches or pull requests

4 participants