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

doc: reformat & improve node.1 manual page #5891

Closed

Conversation

Fishrock123
Copy link
Contributor

Pull Request check-list

Affected core subsystem(s)

Description of change

see #5497 (comment)

cc @thealphanerd

joaocgreis and others added 3 commits March 23, 2016 14:15
Event 9 must include the string terminator in the last descriptor.
Event 23 must be published with no descriptors, in accordance with
the manifest.

PR-URL: nodejs#5742
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
fs.readFile, fs.writeFile and fs.appendFile doc changes
pulled back from master included details not relevant to
v4.

PR-URL: nodejs#5877
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Uses better troff formatting.
Removes v8 options from the man page.

Also edits `node -h` in node.cc slightly.
@Fishrock123 Fishrock123 added doc Issues and PRs related to the documentations. v4.x labels Mar 24, 2016
focused on creating simple, easy to build network clients
and servers.
Node.js is a set of libraries for JavaScript which allows it to be used outside
of the browser. It is primarily focused on creating simple, easy to build
Copy link
Member

Choose a reason for hiding this comment

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

Nit: easy to build -> easy-to-build

@Trott
Copy link
Member

Trott commented Mar 24, 2016

Nit: Verb usage should be consistent. In some command descriptions, it says Prints this or that or Throws this or that. But in others, it says Print this or that or Throw this or that. Either way is fine, but it would be best to pick one and use it everywhere.

@Fishrock123
Copy link
Contributor Author

@Trott Please open a PR correcting these against master, I will not be fixing them in the port.

@Fishrock123
Copy link
Contributor Author

@thealphanerd if lgty land at will into whatever branch

@MylesBorins
Copy link
Contributor

Landed in a761235

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

Successfully merging this pull request may close these issues.

5 participants