GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — doc: sort bottom-of-file markdown links by sam-github · Pull Request #24679 · nodejs/node

Conversation

@sam-github

@sam-github sam-github commented Nov 27, 2018

Copy link
Copy Markdown
Contributor

Reapply #12726

It would be nice to have the sort check applied as part of doc testing,
but this change doesn't implement that.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@nodejs-github-bot

nodejs-github-bot commented Nov 27, 2018

Copy link
Copy Markdown
Collaborator

@sam-github sadly an error occured when I tried to trigger a build :(

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to Node.js documentation. label Nov 27, 2018
@sam-github sam-github mentioned this pull request Nov 27, 2018
[v11.x backport] doc: sort bottom-of-file markdown links #24680
Closed
4 tasks
@sam-github sam-github mentioned this pull request Nov 27, 2018
[v10.x backport] doc: sort bottom-of-file markdown links #24681
Closed
4 tasks
This was referenced Nov 27, 2018
[v8.x backport] doc: sort bottom-of-file markdown links #24682
Closed
[v10.x backport] doc: sort markdown refs in errors #24678
Closed
@sam-github

sam-github commented Nov 27, 2018

Copy link
Copy Markdown
Contributor Author

This won't land on 11, 10, 8, so I prepared backports immediately, see:

  • [v11.x backport] doc: sort bottom-of-file markdown links #24680
  • [v10.x backport] doc: sort bottom-of-file markdown links #24681
  • [v8.x backport] doc: sort bottom-of-file markdown links #24682
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

vsemozhetbyt
vsemozhetbyt approved these changes Nov 27, 2018
View reviewed changes
@vsemozhetbyt

vsemozhetbyt commented Nov 27, 2018 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

We still have one inconsistency. In ASCII the order is: A-Z (upper case), ` (backtick), a-z (lower case). And we conform inside lines, even when it does not seem completely intuitively right (not as in dictionaries):

[`DeflateRaw`]: #zlib_class_zlib_deflateraw
[`Deflate`]: #zlib_class_zlib_deflate

However, as for the first symbol, some documents have upper case letters before backticks (i.e.
consistently):

[Using `options.selectPadding()`]: #http2_using_options_selectpadding
[`'checkContinue'`]: #http2_event_checkcontinue

some documents have upper case letters after backtick (i.e. not consistently):

[`strict mode`]: #assert_strict_mode
[Abstract Equality Comparison]: https://tc39.github.io/ecma262/#sec-abstract-equality-comparison
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@sam-github

sam-github commented Nov 27, 2018

Copy link
Copy Markdown
Contributor Author

@vsemozhetbyt I didn't try to fix all inconsistencies, my goal was to make it locally consistent. There was a fair number of unsorted-by-any-algorithm positions.

Maybe that's a mistake. I would personally prefer to have strict ordering according to the default "C"/Posix locale -- which is ASCII ordering. Entirely ASCII makes it much faster to pass the entire block through programmer's editor's sort command, but IIRC from my first crack at this, existing usage had the backtick docs before all others, so I kept that in order to minimize churn.

vsemozhetbyt reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@sam-github

sam-github commented Nov 27, 2018

Copy link
Copy Markdown
Contributor Author

Btw, I'm willing to go through and resort all the open sorting PRs, time consuming though it is, but only if I know they will be rubber stamped.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@vsemozhetbyt

vsemozhetbyt commented Nov 27, 2018

Copy link
Copy Markdown
Contributor

If you mean the backport PRs, they still have no reviews, but I plan to review them. And I usually compare automatically-sorted-in-editor lists with your variants when the diff is big)

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@vsemozhetbyt

vsemozhetbyt commented Nov 27, 2018 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

Should I wait for resorting in the backporting PRs?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@sam-github

sam-github commented Nov 27, 2018

Copy link
Copy Markdown
Contributor Author

Should you wait? I don't know. If you are OK with this one landing, then yes, go ahead and review the others so they can all land at about the same time.

None of them are backports in the sense that I didn't use git to make them, there are too many differences between branches. I went through and sorted doc/api/*.md with my editor for all the branches to make sure they all end up in the same state, on all branches.

I think the current set of PRs makes all the files locally consistent, which isn't just cosmetic. Its sort of a flag day... any commits landing on master after this that touch the markdown refs will have trouble cherry-picking back to the branches, unless those branches are already sorted.

It would be really nice to have a markdown test tool that enforced ordering.

vsemozhetbyt reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@vsemozhetbyt

vsemozhetbyt commented Nov 27, 2018

Copy link
Copy Markdown
Contributor

I am OK with this one landing as is. I will try to review the others tomorrow.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@vsemozhetbyt

vsemozhetbyt commented Nov 28, 2018

Copy link
Copy Markdown
Contributor

It seems this need rebasing to run CI.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

sam-github added a commit to sam-github/node that referenced this pull request Nov 28, 2018
@sam-github
doc: sort bottom-of-file markdown links
cdea42e
Backport of nodejs#24679
@sam-github
sam-github force-pushed the resort-markdown-refs branch from cfab420 to e208a16 Compare November 28, 2018 17:26
@sam-github

sam-github commented Nov 28, 2018

Copy link
Copy Markdown
Contributor Author

PTAL

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@vsemozhetbyt

vsemozhetbyt commented Nov 28, 2018

Copy link
Copy Markdown
Contributor

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/1709/

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@vsemozhetbyt

vsemozhetbyt commented Nov 28, 2018

Copy link
Copy Markdown
Contributor

Node.js Collaborators, please, add 👍 here if you approve fast-tracking.

vsemozhetbyt, sam-github, and lpinca reacted with thumbs up emoji
All reactions
  • 👍 3 reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@sam-github

sam-github commented Nov 28, 2018

Copy link
Copy Markdown
Contributor Author

I'd like to fast-track to avoid conflicts.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

vsemozhetbyt
vsemozhetbyt reviewed Nov 28, 2018
View reviewed changes
Comment thread doc/api/fs.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

@sam-github
doc: sort bottom-of-file markdown links
f34fede
Reapply nodejs#12726

It would be nice to have the sort check applied as part of doc testing,
but this change doesn't implement that.
@sam-github
sam-github force-pushed the resort-markdown-refs branch from e208a16 to f34fede Compare November 28, 2018 18:22
@Trott Trott closed this Nov 28, 2018
rvagg pushed a commit that referenced this pull request Dec 1, 2018
@sam-github @rvagg
doc: sort bottom-of-file markdown links
ffe1f80
Backport of #24679

PR-URL: #24682
Reviewed-By: Vse Mozhet Byt <[email protected]>
sam-github added a commit to sam-github/node that referenced this pull request Dec 3, 2018
@sam-github
doc: sort bottom-of-file markdown links
476272a
Backport-PR-URL: nodejs#24680
PR-URL: nodejs#24679
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
BridgeAR pushed a commit that referenced this pull request Dec 5, 2018
@sam-github @BridgeAR
doc: sort bottom-of-file markdown links
66d8330
Backport-PR-URL: #24680
PR-URL: #24679
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
@BridgeAR BridgeAR mentioned this pull request Dec 5, 2018
v11.4.0 proposal #24854
Merged
4 tasks done
This was referenced Dec 7, 2018
2018-12-07 Version 11.4.0 (Current) @BridgeAR beevelop/docker-android-nodejs#261
Closed
2018-12-07 Version 11.4.0 (Current) @BridgeAR beevelop/docker-android-nodejs#262
Closed
2018-12-07 Version 11.4.0 (Current) @BridgeAR beevelop/docker-android-nodejs#263
Closed
2018-12-07 Version 11.4.0 (Current) @BridgeAR beevelop/docker-android-nodejs#264
Closed
2018-12-07 Version 11.4.0 (Current) @BridgeAR beevelop/docker-android-nodejs#265
Closed
sam-github added a commit to sam-github/node that referenced this pull request Dec 17, 2018
@sam-github
doc: sort bottom-of-file markdown links
1f22d97
Backport of nodejs#24679
MylesBorins pushed a commit that referenced this pull request Dec 21, 2018
@sam-github @MylesBorins
doc: sort bottom-of-file markdown links
a5727ff
Reapply #12726

It would be nice to have the sort check applied as part of doc testing,
but this change doesn't implement that.

Backport-PR-URL: #24681
PR-URL: #24679
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
MylesBorins pushed a commit that referenced this pull request Dec 26, 2018
@sam-github @MylesBorins
doc: sort bottom-of-file markdown links
d2cc9d7
Reapply #12726

It would be nice to have the sort check applied as part of doc testing,
but this change doesn't implement that.

Backport-PR-URL: #24681
PR-URL: #24679
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
@codebytere codebytere mentioned this pull request Jan 4, 2019
v10.15.1 proposal #25346
Merged
refack pushed a commit to refack/node that referenced this pull request Jan 14, 2019
@sam-github @refack
doc: sort bottom-of-file markdown links
2db252f
Reapply nodejs#12726

It would be nice to have the sort check applied as part of doc testing,
but this change doesn't implement that.

PR-URL: nodejs#24679
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
This was referenced Jan 29, 2019
2019-01-29 Version 10.15.1 'Dubnium' (LTS) @codebytere beevelop/docker-android-nodejs#280
Closed
2019-01-29 Version 10.15.1 'Dubnium' (LTS) @codebytere beevelop/docker-nodejs#258
Closed
2019-01-29 Version 10.15.1 'Dubnium' (LTS) @codebytere beevelop/docker-android-nodejs#281
Closed
2019-01-29 Version 10.15.1 'Dubnium' (LTS) @codebytere beevelop/docker-nodejs#259
Closed
2019-01-29 Version 10.15.1 'Dubnium' (LTS) @codebytere beevelop/docker-android-nodejs#282
Closed
2019-01-29 Version 10.15.1 'Dubnium' (LTS) @codebytere beevelop/docker-nodejs#260
Closed
2019-01-29 Version 10.15.1 'Dubnium' (LTS) @codebytere beevelop/docker-android-nodejs#283
Closed
2019-01-29 Version 10.15.1 'Dubnium' (LTS) @codebytere beevelop/docker-nodejs#261
Closed
2019-01-29 Version 10.15.1 'Dubnium' (LTS) @codebytere beevelop/docker-android-nodejs#284
Closed
2019-01-29 Version 10.15.1 'Dubnium' (LTS) @codebytere beevelop/docker-nodejs#262
Closed
@sam-github
sam-github deleted the resort-markdown-refs branch March 20, 2019 15:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lpinca lpinca lpinca approved these changes
+1 more reviewer
@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

author ready PRs with CI started, the required approvals, and no outstanding review comments. doc Issues and PRs related to Node.js documentation. fast-track PRs proposed for a shorter-than-standard waiting period before landing.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@sam-github @nodejs-github-bot @vsemozhetbyt @Trott @lpinca
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.