doc: fix links order in Assert doc#5074
doc: fix links order in Assert doc#5074estliberitas wants to merge 1 commit intonodejs:masterfrom estliberitas:doc-assert-link-order
Conversation
Sort links in lexical order
thefourtheye
added
assert
| [`Error`]: errors.html#errors_class_error | ||
| [`RegExp`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions | ||
| [`TypeError`]: errors.html#errors_class_typeerror | ||
| [Locked]: documentation.html#documentation_stability_index |
There was a problem hiding this comment.
Wouldn't this come just before RegExp if it is in lexical (aka alphabetical) order?
There was a problem hiding this comment.
@DavidTPate lexicographic !== alphabetic from what I know
Like: lexical (lexicographic) ⊃ alphabetical
There was a problem hiding this comment.
Something just doesn't seem right, Lexicographic on Wikipedia for example.
the lexicographic or lexicographical order (also known as lexical order, dictionary order, alphabetical order or lexicographic(al) product) is a generalization of the way the alphabetical order of words is based on the alphabetical order of their component letters.
This isn't ordered by the ASCII values as A (#65) comes before a (#97) in ASCII values. As an example:
['Locked', 'assert.deepEqual()', 'assert.deepStrictEqual()', 'assert.ok()','Error','RegExp', 'TypeError'].sort();
// ["Error", "Locked", "RegExp", "TypeError", "assert.deepEqual()", "assert.deepStrictEqual()", "assert.ok()"]
'RegExp' > 'Locked';
// trueI'm not trying to hold this PR up, just lost as to how this ordering occurred and wondering if the other PRs are in an odd order as well.
There was a problem hiding this comment.
Ah, yes, talking about case - I used case-insensitive check. So talking about alphabet, I used case-insensitive one. 😉
There was a problem hiding this comment.
It all started with #5003, so I assumed, this is a good way to go.
There was a problem hiding this comment.
Btw, maybe that's me who misunderstands lex and alphabetical order...
|
LGTM |
|
Hmm, this one is borderline of being unneccessary in my eyes. Do links in other docs conform to a sorting? Maybe handle them all in one PR here? |
|
@silverwind I'm ok with that |
|
I'll close this one then as it barely has any value, if you wanna do it for all docs, follow up with a new one 😉 |
6 participants
Sort links in lexical order