Skip to content

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

@Alex-Temny

Description

@Alex-Temny

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to the documentations.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions