doc: update os.markdown #976
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
LGTM, except the commit message should start with |
|
What @tellnes said. Otherwise LGTM. |
|
Thanks, I've renamed it appropriately. |
|
|
||
| ## os.endianness() | ||
|
|
||
| Returns the endianness of the CPU. Possible values are `"BE"` or `"LE"`. | ||
| Returns the endianness of the CPU. Possible values are `'BE'` for big endian | ||
| or `'LE'` for little endien. |
|
@brendanashworth thanks! Fixed and squashed. |
| @@ -20,16 +21,18 @@ Returns the hostname of the operating system. | |||
|
|
|||
| ## os.type() | |||
|
|
|||
| Returns the operating system name. | |||
| Returns the operating system name. For example 'Linux' on Linux, 'Darwin' on | |||
| OSX and 'Windows_NT' on Windows. | |||
Some doc update based on improvement ideas I remember from when I used this module in node: - Mention windows returns 0 for `nice` values (which is obvious, but io makes no attempt to calculate something similar or return undefined, 0 is returned) - Mention platform and arch are aliases for `process` properties. - Document possible return values where appropriate, add examples in others. - Rename title in order to match other titles in the navigation. - Fix line that was over 80 characters long.
|
Thanks @vkurchatkin! I've changed the quoting per your suggestion - it's worth mentioning it's not consistent throughout the docs (discussed in Domenic's promise event docs PR) |
|
LGTM |
tellnes
pushed a commit
that referenced
this pull request
Feb 27, 2015
Some doc update based on improvement ideas I remember from when I used this module in node: - Mention windows returns 0 for `nice` values (which is obvious, but io makes no attempt to calculate something similar or return undefined, 0 is returned) - Mention platform and arch are aliases for `process` properties. - Document possible return values where appropriate, add examples in others. - Rename title in order to match other titles in the navigation. - Fix line that was over 80 characters long. PR-URL: #976 Reviewed-By: Christian Tellnes <christian@tellnes.no> Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: Vladimir Kurchatkin <vladimir.kurchatkin@gmail.com>
|
Landed as f83d380 |
This was referenced Jul 8, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some doc update based on improvement ideas I remember from when I used this module in node:
nicevalues (which is obvious, but io makes no attempt to calculate something similar or return undefined, 0 is returned)processproperties.