doc: sort documentation alphabetically - #3662
Conversation
Sorry, something went wrong.
Reorders, with no contextual changes, the assert documentation alphabetically.
Reorders, with minimal contextual duplication, the buffer documentation alphabetically.
Reorders, with no contextual changes, the child_process documentation alphabetically.
Reorders, with no contextual changes, the cluster documentation alphabetically.
Reorders, with no contextual changes, the console documentation alphabetically.
Reorders, with no contextual changes, the dns documentation alphabetically.
|
@tflanagan could you please push new commits, or amend + force-push instead of opening new PRs? thanks! :D |
Sorry, something went wrong.
|
cc @nodejs/documentation -- I am greatly in favor of this. |
Sorry, something went wrong.
|
@Fishrock123, I had to open a new PR because the old one was against v4.x, I am sorry for polluting. |
Sorry, something went wrong.
|
I can't seem to find any one convention with the ordering of classes, methods, properties, and random text blurbs |
Sorry, something went wrong.
|
@tflanagan ... thank you for this work. It's great stuff. And thank you for bearing with me on the targeting of the PR (I know it's a pain). I should have time to take a look at the changes in detail later on today or tomorrow but so far things are looking good. |
Sorry, something went wrong.
|
The zlib documentation is completely different from the rest of the docs. I'm about to commit this file, but just want to give a heads up. Things I changed:
The convenience methods subtree is an odd ball compared to the rest of the docs. So is Class Options and Constants. This file should really be conformed to the rest of the docs. --- I'll have this finished by the end of the day, will do a rebase on master and pull in the new changes since this PR. |
Sorry, something went wrong.
Reorders, with no contextual changes, the crypto documentation alphabetically.
Reorders, with no contextual changes, the dgram documentation alphabetically.
Reorders, with no contextual changes, the errors documentation alphabetically.
Reorders, with minimal contextual duplication, the events documentation alphabetically.
Reorders, with no contextual changes, the fs documentation alphabetically.
Reorders, with no contextual changes, the globals documentation alphabetically.
Reorders, with no contextual changes, the os documentation alphabetically.
Reorders, with no contextual changes, the path documentation alphabetically.
Reorders, with no contextual changes, the punycode documentation alphabetically.
Reorders, with no contextual changes, the querystring documentation alphabetically.
Reorders, with no contextual changes, the vm documentation alphabetically.
Reorders, with no contextual changes, the url documentation alphabetically.
Reorders, with no contextual changes, the tty documentation alphabetically.
Reorders, with no contextual changes, the timers documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reorders, with no contextual changes, the string_decode documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reorders, with no contextual changes, the repl documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reorders, with no contextual changes, the readline documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reorders, with no contextual changes, the modules documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reorders, with no contextual changes, the http documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reorders, with no contextual changes, the https documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reorders, with no contextual changes, the util documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reorders, with some contextual changes, the zlib documentation alphabetically. - Put Convenience Methods children under the Convenience Methods header - Renamed Options to Class Options and put above the Class definitions PR-URL: #3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reorders, with no contextual changes, the process documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reorders, with minimal contextual duplication, the net documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reorders, with no contextual changes, the stream documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
|
Working on this right now for lts... as you can imagine it is not the friendliest. For the most part there were no major problems expect for TLS where there were a barrage of changes that came in before the doc fix. |
Sorry, something went wrong.
|
phew... that was intense but all done. Had to manually recreate f8390fd as 65267bc due to the amount of conflicts landed in v4.x-staging in 8b6120d...65267bc |
Sorry, something went wrong.
|
Nice work! Thank you! |
Sorry, something went wrong.
As a follow up to #3651, #3652, and to #393, I've started from the top and am working my way down.
I am posting this now because it is a big diff and will need eyes.
Docs that have been completed: