Robert Jefe Lindstaedt
e436272897
doc: fenced all code blocks, typo fixes
...
This changes the code blocks from 4-space indentation to ``` fences for
better syntax highlighting and future linting support. Minor On-the-fly
changes for typos and highlight breaking markdown have been made.
JSON-Style objects have been changed so their closing bracket is
on the same line as the opening one.
Known issues:
* Not every JSON / object notation has been improved. Should
make another run for this.
* Some example functions break hightlighting due to various
combinations of brackets. However changing them means leaving
the code style.
Fixes: https://github.com/nodejs/node/issues/4726
PR-URL: https://github.com/nodejs/node/pull/4733
Reviewed-By: Roman Reiss <me@silverwind.io >
2016-01-21 20:55:09 +01:00
Richard Sun
a2e77cedef
doc: remove "above" and "below" references
...
The docs were recently refactored, and some "above" and "below"
references were no longer accurate. This commit removes many
such references, and replaces others with links.
PR-URL: https://github.com/nodejs/node/pull/4499
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-01-11 13:06:00 -05:00
James M Snell
bbb4a2a517
doc: improvements to errors.markdown copy
...
General improvements to errors.markdown including
improved/revised examples
PR-URL: https://github.com/nodejs/node/pull/4454
Reviewed-By: Myles Borins <myles.borins@gmail.com >
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com >
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com >
2016-01-04 08:40:09 -08:00
James M Snell
9b21119e17
doc: fix, modernize examples in docs
...
* Use single quotes consistently
* Modernize examples to use template strings and arrow funcs
* Fix a few typos
* Example edits for consistency
PR-URL: https://github.com/nodejs/node/pull/4282
Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2015-12-17 08:07:29 -08:00
Tom Gallacher
9a9c5259bf
doc: Fixing broken links to the v8 wiki
...
PR-URL: https://github.com/nodejs/node/pull/4241
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com >
2015-12-11 10:24:46 -08:00
jpersson
7e4f22ca13
doc: update links to use https where possible
...
PR-URL: https://github.com/nodejs/node/pull/4054
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-12-03 13:40:10 -08:00
jpersson
14b3aab7d2
doc: add links and backticks around names
...
* add backticks around names
* add single quotes around event names
* add parenthesis after function names
* add internal links between different sections
* add external links to MDN for some JavaScript references
* sort the link definitions alphabetically
PR-URL: https://github.com/nodejs/node/pull/4054
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-12-03 13:39:09 -08:00
yorkie
2fb34b6132
doc: fix the exception description
...
A value shouldn't be described as doing inherit from some class, more
strictly, the value is an instance of the class `Error`.
PR-URL: https://github.com/nodejs/node/pull/3658
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: Stephan Belanger <admin@stephenbelanger.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
2015-11-30 18:29:52 -08:00
Alexander Gromnitsky
94c3507f5c
doc: fix broken references
...
PR-URL: https://github.com/nodejs/node/pull/3944
Reviewed-By: targos - Michaël Zasso <mic.besace@gmail.com >
Reviewed-By: Myles Borins <mborins@us.ibm.com >
2015-11-20 11:52:23 -08:00
Bryan English
cd1123a0fb
doc: consistent reference-style links
...
Moved all the URLs in API docs to the bottom of the files as
reference-style links.
PR-URL: https://github.com/nodejs/node/pull/3845
Reviewed-By: James M Snell <jasnell@gmail.com >
2015-11-16 07:36:59 -08:00
Tristian Flanagan
084e540397
doc: sort errors alphabetically
...
Reorders, with no contextual changes, the errors documentation
alphabetically.
PR-URL: https://github.com/nodejs/node/pull/3662
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2015-11-12 17:39:42 -08:00
reggi
ffdbe9d4f1
doc: fix typos in cluster & errors
...
PR-URL: https://github.com/nodejs/node/pull/3011
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-09-23 22:06:43 +02:00
Sakthipriyan Vairamani
7953c83b85
doc: remove usage of events.EventEmitter
...
The `events` module already exports `EventEmitter` constructor function
So, we don't have to use `events.EventEmitter` to access it.
Refer: https://github.com/nodejs/node/pull/2896
PR-URL: https://github.com/nodejs/node/pull/2921
Reviewed-By: Roman Reiss <me@silverwind.io >
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
2015-09-23 00:22:11 +05:30
cjihrig
a69ab27ab4
node: rename from io.js to node
...
This commit replaces instances of io.js with Node.js, based on the
recent convergence. There are some remaining instances of io.js,
related to build and the installer.
Fixes: https://github.com/nodejs/node/issues/2361
PR-URL: https://github.com/nodejs/node/pull/2367
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: João Reis <reis@janeasystems.com >
2015-08-23 17:59:43 -04:00
Ryan Seys
c3c2fbdf83
doc: change effect to affect in errors.md
...
PR-URL: https://github.com/iojs/io.js/pull/799
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2015-02-11 14:24:43 -05:00
Chris Dickinson
dbf75924f1
doc: update error links
...
PR-URL: https://github.com/iojs/io.js/pull/793
Reviewed-by: Rod Vagg <rod@vagg.org >
2015-02-10 19:39:41 -08:00
Chris Dickinson
7e2235aebb
doc: add error documentation
...
PR-URL: https://github.com/iojs/io.js/pull/789
Reviewed-by: Rod Vagg <rod@vagg.org >
Reviewed-By: Trevor Norris <trev.norris@gmail.com >
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2015-02-10 17:58:10 -08:00