doc: update os.markdown
authorBenjamin Gruenbaum <inglor@gmail.com>
Thu, 26 Feb 2015 21:57:45 +0000 (23:57 +0200)
committerChristian Tellnes <christian@tellnes.no>
Fri, 27 Feb 2015 14:22:38 +0000 (15:22 +0100)
commitf83d380647bd95fffd4944d371366e5b6b24d97c
treed2d360604e70b9e225d3363cada5294b7a11c408
parent4d1fa2ca97e3e8118c2156b6fe9dd5b4d705525a
doc: update os.markdown

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: https://github.com/iojs/io.js/pull/976
Reviewed-By: Christian Tellnes <christian@tellnes.no>
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: Vladimir Kurchatkin <vladimir.kurchatkin@gmail.com>
doc/api/os.markdown