Skip to content

Conversation

@benjamingr
Copy link
Member

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.

@tellnes
Copy link
Contributor

tellnes commented Feb 26, 2015

LGTM, except the commit message should start with doc:

@mscdex
Copy link
Contributor

mscdex commented Feb 26, 2015

What @tellnes said. Otherwise LGTM.

@benjamingr benjamingr changed the title Update os.markdown doc: update os.markdown Feb 26, 2015
@benjamingr
Copy link
Member Author

Thanks, I've renamed it appropriately.

Copy link
Contributor

Choose a reason for hiding this comment

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

spelling, endian

@benjamingr
Copy link
Member Author

@brendanashworth thanks! Fixed and squashed.

Copy link
Contributor

Choose a reason for hiding this comment

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

OS X

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.
@benjamingr
Copy link
Member Author

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)

@vkurchatkin
Copy link
Contributor

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 <[email protected]>
Reviewed-By: Brian White <[email protected]>
Reviewed-By: Vladimir Kurchatkin <[email protected]>
@tellnes
Copy link
Contributor

tellnes commented Feb 27, 2015

Landed as f83d380

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants