Browse Source

doc: enable no-file-name-articles remark-lint rule

This renames doc/topics/the-event-loop-timers-and-nexttick.md to
doc/topics/event-loop-timers-and-nexttick.md, which looks like a
better name for that file and enables no-file-name-articles remark-lint
rule to prevent such names in the future.

PR-URL: https://github.com/nodejs/node/pull/8713
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Ilkka Myller <ilkka.myller@nodefield.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
v6
Сковорода Никита Андреевич 8 years ago
committed by James M Snell
parent
commit
bedc6b6247
  1. 2
      .remarkrc
  2. 2
      doc/api/timers.md
  3. 6
      doc/guides/timers-in-node.md
  4. 0
      doc/topics/event-loop-timers-and-nexttick.md

2
.remarkrc

@ -30,7 +30,7 @@
"no-duplicate-definitions": true,
"no-duplicate-headings": false,
"no-emphasis-as-heading": false,
"no-file-name-articles": false,
"no-file-name-articles": true,
"no-file-name-consecutive-dashes": true,
"no-file-name-irregular-characters": false,
"no-file-name-mixed-case": false,

2
doc/api/timers.md

@ -163,7 +163,7 @@ added: v0.0.1
Cancels a `Timeout` object created by [`setTimeout()`][].
[the Node.js Event Loop]: https://github.com/nodejs/node/blob/master/doc/topics/the-event-loop-timers-and-nexttick.md
[the Node.js Event Loop]: https://github.com/nodejs/node/blob/master/doc/topics/event-loop-timers-and-nexttick.md
[`TypeError`]: errors.html#errors_class_typeerror
[`clearImmediate()`]: timers.html#timers_clearimmediate_immediate
[`clearInterval()`]: timers.html#timers_clearinterval_timeout

6
doc/guides/timers-in-node.md

@ -10,7 +10,7 @@ period of time. Timers do not need to be imported via `require()`, since
all the methods are available globally to emulate the browser JavaScript API.
To fully understand when timer functions will be executed, it's a good idea to
read up on the the Node.js
[Event Loop](../topics/the-event-loop-timers-and-nexttick).
[Event Loop](../topics/event-loop-timers-and-nexttick).
## Controlling the Time Continuum with Node.js
@ -96,7 +96,7 @@ some major ways they differ. The first is that `process.nextTick()` will run
*before* any `Immediate`s that are set as well as before any scheduled I/O.
The second is that `process.nextTick()` is non-clearable, meaning once
code has been scheduled to execute with `process.nextTick()`, the execution
cannot be stopped, just like with a normal function. Refer to [this guide](../topics/the-event-loop-timers-and-nexttick#processnexttick)
cannot be stopped, just like with a normal function. Refer to [this guide](../topics/event-loop-timers-and-nexttick#processnexttick)
to better understand the operation of `process.nextTick()`.
### "Infinite Loop" Execution ~ *`setInterval()`*
@ -189,4 +189,4 @@ There's much more to the Event Loop and Timers than this guide
has covered. To learn more about the internals of the Node.js
Event Loop and how Timers operate during execution, check out
this Node.js guide: [The Node.js Event Loop, Timers, and
process.nextTick()](../topics/the-event-loop-timers-and-nexttick.md).
process.nextTick()](../topics/event-loop-timers-and-nexttick.md).

0
doc/topics/the-event-loop-timers-and-nexttick.md → doc/topics/event-loop-timers-and-nexttick.md

Loading…
Cancel
Save