Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
doc: sort bottom-of-file markdown links #24679
It would be nice to have the sort check applied as part of doc testing,
We still have one inconsistency. In ASCII the order is:
[`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.
[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
@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.
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
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.