From bedc6b624729c24833bd5705bbb33e8fbd3c2267 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=A1=D0=BA=D0=BE=D0=B2=D0=BE=D1=80=D0=BE=D0=B4=D0=B0=20?= =?UTF-8?q?=D0=9D=D0=B8=D0=BA=D0=B8=D1=82=D0=B0=20=D0=90=D0=BD=D0=B4=D1=80?= =?UTF-8?q?=D0=B5=D0=B5=D0=B2=D0=B8=D1=87?= Date: Tue, 20 Sep 2016 15:12:23 +0300 Subject: [PATCH] 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 Reviewed-By: Ben Noordhuis Reviewed-By: Ilkka Myller Reviewed-By: James M Snell --- .remarkrc | 2 +- doc/api/timers.md | 2 +- doc/guides/timers-in-node.md | 6 +++--- ...rs-and-nexttick.md => event-loop-timers-and-nexttick.md} | 0 4 files changed, 5 insertions(+), 5 deletions(-) rename doc/topics/{the-event-loop-timers-and-nexttick.md => event-loop-timers-and-nexttick.md} (100%) diff --git a/.remarkrc b/.remarkrc index 5244bd758c8..b8cee4c2bb8 100644 --- a/.remarkrc +++ b/.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, diff --git a/doc/api/timers.md b/doc/api/timers.md index 729a134171f..75d6a36737b 100644 --- a/doc/api/timers.md +++ b/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 diff --git a/doc/guides/timers-in-node.md b/doc/guides/timers-in-node.md index d6a594e150f..6cdbd35b21f 100644 --- a/doc/guides/timers-in-node.md +++ b/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). diff --git a/doc/topics/the-event-loop-timers-and-nexttick.md b/doc/topics/event-loop-timers-and-nexttick.md similarity index 100% rename from doc/topics/the-event-loop-timers-and-nexttick.md rename to doc/topics/event-loop-timers-and-nexttick.md