Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: enable no-file-name-articles remark-lint rule and rename doc/topics/the-event-loop-timers-and-nexttick.md #8713

Closed
wants to merge 1 commit into from

Conversation

ChALkeR
Copy link
Member

@ChALkeR ChALkeR commented Sep 22, 2016

Checklist
  • make -j4 test (UNIX), or vcbuild test nosign (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc, tools

Description of change

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.

This change is likely controversial because it breaks direct links to that file in the repository, so I made a stand-alone PR for it to be reviewed separately.

That file was merged this April in #4936.

/cc @techjeffharris, @nodejs/documentation, @Trott, @addaleax, @nodejs/collaborators.

@ChALkeR ChALkeR added doc Issues and PRs related to the documentations. discuss Issues opened for discussions and feedbacks. tools Issues and PRs related to the tools directory. labels Sep 22, 2016
@ChALkeR ChALkeR changed the title tools, doc: enable no-file-name-articles lint rule and rename doc/topics/the-event-loop-timers-and-nexttick.md doc: enable no-file-name-articles lint rule and rename doc/topics/the-event-loop-timers-and-nexttick.md Sep 22, 2016
@ChALkeR ChALkeR changed the title doc: enable no-file-name-articles lint rule and rename doc/topics/the-event-loop-timers-and-nexttick.md doc: enable no-file-name-articles remark-lint rule and rename doc/topics/the-event-loop-timers-and-nexttick.md Sep 22, 2016
@addaleax
Copy link
Member

This change is likely controversial because it breaks direct links to that file in the repository

Could you change the references to that .md that are in our docs/, so those will be correct? ;)

@mcollina
Copy link
Member

LGTM.

Side question. Was that file published somewhere on our website?

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: nodejs#8713
@ChALkeR
Copy link
Member Author

ChALkeR commented Sep 22, 2016

@addaleax Argh, totally missed that, thanks!
Updated.

@ChALkeR
Copy link
Member Author

ChALkeR commented Sep 22, 2016

@mcollina

Was that file published somewhere on our website?

Doesn't look like it. https://nodejs.org/api/timers.html#timers_setimmediate_callback_arg links directly to the GitHub repo.

See also https://google.com/search?q=inurl:the-event-loop-timers-and-nexttick — those all are inside the repo.

Copy link
Member

@bnoordhuis bnoordhuis left a comment

Choose a reason for hiding this comment

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

But I'm so naming everything teh-foo-bar.md from now on.

Copy link
Member

@imyller imyller left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@jasnell jasnell left a comment

Choose a reason for hiding this comment

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

LGTM

@ChALkeR
Copy link
Member Author

ChALkeR commented Sep 26, 2016

@bnoordhuis

But I'm so naming everything teh-foo-bar.md from now on.

I just filed remarkjs/remark-lint#100 😉.

jasnell pushed a commit that referenced this pull request Sep 27, 2016
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: #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>
@jasnell
Copy link
Member

jasnell commented Sep 27, 2016

Landed in bedc6b6

@jasnell jasnell closed this Sep 27, 2016
jasnell pushed a commit that referenced this pull request Sep 29, 2016
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: #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>
Fishrock123 pushed a commit that referenced this pull request Oct 11, 2016
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: #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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss Issues opened for discussions and feedbacks. doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants