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.

Sign up for GitHub

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

Jump to bottom

doc: sort documentation alphabetically #3662

Closed
wants to merge 32 commits into from
Closed

doc: sort documentation alphabetically #3662

wants to merge 32 commits into from

Conversation

tflanagan
Copy link
Contributor

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:

  • assert
  • buffer
  • child_process
  • cluster
  • console
  • crypto
  • debugger
  • dgram
  • dns
  • domain
  • errors
  • events
  • fs
  • globals
  • http
  • https
  • modules
  • net
  • os
  • path
  • process
  • punycode
  • querystring
  • readline
  • repl
  • stream
  • string_decoder
  • timers
  • tls
  • tty
  • url
  • util
  • v8 - No changes
  • vm
  • zlib

@tflanagan
doc: sort assert alphabetically
ecd2179 
Reorders, with no contextual changes, the assert documentation
alphabetically.
@tflanagan
doc: sort buffer alphabetically
63a2e55 
Reorders, with minimal contextual duplication, the buffer documentation
alphabetically.
@tflanagan
doc: sort child_process alphabetically
7b4f78a 
Reorders, with no contextual changes, the child_process documentation
alphabetically.
@tflanagan
doc: sort cluster alphabetically
e650680 
Reorders, with no contextual changes, the cluster documentation
alphabetically.
@tflanagan
doc: sort console alphabetically
cfed942 
Reorders, with no contextual changes, the console documentation
alphabetically.
@tflanagan
doc: sort dns alphabetically
03dd92c 
Reorders, with no contextual changes, the dns documentation
alphabetically.
@tflanagan tflanagan mentioned this pull request Nov 4, 2015
Closed
8 tasks
@Fishrock123
Copy link
Contributor

@tflanagan could you please push new commits, or amend + force-push instead of opening new PRs? thanks! :D

@Fishrock123 Fishrock123 added the doc Issues and PRs related to the documentations. label Nov 4, 2015
@Fishrock123
Copy link
Contributor

cc @nodejs/documentation -- I am greatly in favor of this.

@tflanagan
Copy link
Contributor Author

@Fishrock123, I had to open a new PR because the old one was against v4.x, I am sorry for polluting.

@tflanagan
Copy link
Contributor Author

I can't seem to find any one convention with the ordering of classes, methods, properties, and random text blurbs

@jasnell
Copy link
Member

jasnell commented Nov 4, 2015

@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.

@tflanagan
Copy link
Contributor Author

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:

  • Put Convenience Methods children under the Convenience Methods header
  • Renamed Options to Class Options and put above the Class definitions

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.

@tflanagan
doc: sort crypto alphabetically
d9e5b6a 
Reorders, with no contextual changes, the crypto documentation
alphabetically.
@tflanagan
doc: sort dgram alphabetically
43f2da0 
Reorders, with no contextual changes, the dgram documentation
alphabetically.
@tflanagan
doc: sort errors alphabetically
b85d3ac 
Reorders, with no contextual changes, the errors documentation
alphabetically.
@tflanagan
doc: sort events alphabetically
03129f8 
Reorders, with minimal contextual duplication, the events documentation
alphabetically.
@tflanagan
doc: sort fs alphabetically
c44523a 
Reorders, with no contextual changes, the fs documentation
alphabetically.
@tflanagan
doc: sort globals alphabetically
0c181d1 
Reorders, with no contextual changes, the globals documentation
alphabetically.
@tflanagan
doc: sort os alphabetically
99c8160 
Reorders, with no contextual changes, the os documentation alphabetically.
@tflanagan
doc: sort path alphabetically
820506e 
Reorders, with no contextual changes, the path documentation
alphabetically.
@tflanagan
doc: sort punycode alphabetically
33a6975 
Reorders, with no contextual changes, the punycode documentation
alphabetically.
@tflanagan
doc: sort querystring alphabetically
5c37462 
Reorders, with no contextual changes, the querystring documentation
alphabetically.
@tflanagan
doc: sort vm alphabetically
ac62941 
Reorders, with no contextual changes, the vm documentation alphabetically.
@tflanagan
doc: sort url alphabetically
8c83054 
Reorders, with no contextual changes, the url documentation
alphabetically.
@tflanagan
doc: sort tty alphabetically
cc6f224 
Reorders, with no contextual changes, the tty documentation
alphabetically.
jasnell pushed a commit that referenced this pull request Dec 23, 2015
@tflanagan @jasnell
doc: sort querystring alphabetically
34b54b8 
Reorders, with no contextual changes, the querystring 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>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
@tflanagan @jasnell
doc: sort vm alphabetically
2d72ad7 
Reorders, with no contextual changes, the vm 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>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
@tflanagan @jasnell
doc: sort url alphabetically
0f3a7d9 
Reorders, with no contextual changes, the url 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>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
@tflanagan @jasnell
doc: sort tty alphabetically
d0dd0a9 
Reorders, with no contextual changes, the tty 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>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
@tflanagan @jasnell
doc: sort timers alphabetically
472da7a 
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>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
@tflanagan @jasnell
doc: sort string_decoder alphabetically
d1e2e3b 
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>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
@tflanagan @jasnell
doc: sort repl alphabetically
e387892 
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>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
@tflanagan @jasnell
doc: sort readline alphabetically
aed750c 
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>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
@tflanagan @jasnell
doc: sort modules alphabetically
35b9c99 
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>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
@tflanagan @jasnell
doc: sort http alphabetically
761626a 
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>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
@tflanagan @jasnell
doc: sort https alphabetically
74044de 
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>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
@tflanagan @jasnell
doc: sort util alphabetically
2d350e9 
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>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
@tflanagan @jasnell
doc: sort zlib alphabetically
29053fe 
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>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
@tflanagan @jasnell
doc: sort process alphabetically
a306c0d 
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>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
@tflanagan @jasnell
doc: sort net alphabetically
cf7befc 
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>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
@tflanagan @jasnell
doc: sort stream alphabetically
4ecec22 
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>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
@tflanagan @jasnell
doc: sort tls alphabetically
61db331 
Reorders, with no contextual changes, the tls 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>
@richardsun29 richardsun29 mentioned this pull request Dec 31, 2015
Closed
@jmm jmm mentioned this pull request Jan 6, 2016
Closed
bbondy pushed a commit to brave/node that referenced this pull request Mar 13, 2016
@Fishrock123 @bbondy
2015-11-17, Version 5.1.0 (Stable)
f3c29fc 
Notable changes:

* buffer: The `noAssert` option for many buffer functions will now silently drop invalid write values rather than crashing (P.S.V.R) nodejs/node#3767.
  - This makes the behavior match what the docs suggest.
* child_process: `child.send()` now properly returns a boolean like
the docs suggest (Rich Trott) nodejs/node#3577.
* doc: All of the API docs have been re-ordered so as to read in alphabetical order (Tristian Flanagan) nodejs/node#3662.
* http_parser: update http-parser to 2.6.0 from 2.5.0 (James M
Snell) nodejs/node#3569.
  - Now supports the following HTTP methods: `LINK`, `UNLINK`, `BIND`,
`REBIND`, `UNBIND`.
  - Also added ACL and IPv6 Zone ID support.
* npm: upgrade npm to 3.3.12 from v3.3.6 (Rebecca Turner)
nodejs/node#3685.
  - See the release notes for
    https://github.com/npm/npm/releases/tag/v3.3.7,
    https://github.com/npm/npm/releases/tag/v3.3.8,
    https://github.com/npm/npm/releases/tag/v3.3.9,
    https://github.com/npm/npm/releases/tag/v3.3.10,
    https://github.com/npm/npm/releases/tag/v3.3.11, and
    https://github.com/npm/npm/releases/tag/v3.3.12 for more details.
* repl: The REPL no longer crashes if the persistent history file
cannot be opened (Evan Lucas) nodejs/node#3630.
* tls: The default `sessionIdContext` now uses SHA1 in FIPS mode rather than MD5 (Stefan Budeanu) nodejs/node#3755.
* v8: Added some more useful post-mortem data (Fedor Indutny) nodejs/node#3779.

PR-URL: nodejs/node#3736
bbondy pushed a commit to brave/node that referenced this pull request Mar 14, 2016
@Fishrock123 @bbondy
2015-11-17, Version 5.1.0 (Stable)
d76b19c 
Notable changes:

* buffer: The `noAssert` option for many buffer functions will now silently drop invalid write values rather than crashing (P.S.V.R) nodejs/node#3767.
  - This makes the behavior match what the docs suggest.
* child_process: `child.send()` now properly returns a boolean like
the docs suggest (Rich Trott) nodejs/node#3577.
* doc: All of the API docs have been re-ordered so as to read in alphabetical order (Tristian Flanagan) nodejs/node#3662.
* http_parser: update http-parser to 2.6.0 from 2.5.0 (James M
Snell) nodejs/node#3569.
  - Now supports the following HTTP methods: `LINK`, `UNLINK`, `BIND`,
`REBIND`, `UNBIND`.
  - Also added ACL and IPv6 Zone ID support.
* npm: upgrade npm to 3.3.12 from v3.3.6 (Rebecca Turner)
nodejs/node#3685.
  - See the release notes for
    https://github.com/npm/npm/releases/tag/v3.3.7,
    https://github.com/npm/npm/releases/tag/v3.3.8,
    https://github.com/npm/npm/releases/tag/v3.3.9,
    https://github.com/npm/npm/releases/tag/v3.3.10,
    https://github.com/npm/npm/releases/tag/v3.3.11, and
    https://github.com/npm/npm/releases/tag/v3.3.12 for more details.
* repl: The REPL no longer crashes if the persistent history file
cannot be opened (Evan Lucas) nodejs/node#3630.
* tls: The default `sessionIdContext` now uses SHA1 in FIPS mode rather than MD5 (Stefan Budeanu) nodejs/node#3755.
* v8: Added some more useful post-mortem data (Fedor Indutny) nodejs/node#3779.

PR-URL: nodejs/node#3736
bbondy pushed a commit to brave/node that referenced this pull request Mar 14, 2016
@Fishrock123 @bbondy
2015-11-17, Version 5.1.0 (Stable)
22187ec 
Notable changes:

* buffer: The `noAssert` option for many buffer functions will now silently drop invalid write values rather than crashing (P.S.V.R) nodejs/node#3767.
  - This makes the behavior match what the docs suggest.
* child_process: `child.send()` now properly returns a boolean like
the docs suggest (Rich Trott) nodejs/node#3577.
* doc: All of the API docs have been re-ordered so as to read in alphabetical order (Tristian Flanagan) nodejs/node#3662.
* http_parser: update http-parser to 2.6.0 from 2.5.0 (James M
Snell) nodejs/node#3569.
  - Now supports the following HTTP methods: `LINK`, `UNLINK`, `BIND`,
`REBIND`, `UNBIND`.
  - Also added ACL and IPv6 Zone ID support.
* npm: upgrade npm to 3.3.12 from v3.3.6 (Rebecca Turner)
nodejs/node#3685.
  - See the release notes for
    https://github.com/npm/npm/releases/tag/v3.3.7,
    https://github.com/npm/npm/releases/tag/v3.3.8,
    https://github.com/npm/npm/releases/tag/v3.3.9,
    https://github.com/npm/npm/releases/tag/v3.3.10,
    https://github.com/npm/npm/releases/tag/v3.3.11, and
    https://github.com/npm/npm/releases/tag/v3.3.12 for more details.
* repl: The REPL no longer crashes if the persistent history file
cannot be opened (Evan Lucas) nodejs/node#3630.
* tls: The default `sessionIdContext` now uses SHA1 in FIPS mode rather than MD5 (Stefan Budeanu) nodejs/node#3755.
* v8: Added some more useful post-mortem data (Fedor Indutny) nodejs/node#3779.

PR-URL: nodejs/node#3736
bbondy pushed a commit to brave/node that referenced this pull request Mar 15, 2016
@Fishrock123 @bbondy
2015-11-17, Version 5.1.0 (Stable)
fbd3d02 
Notable changes:

* buffer: The `noAssert` option for many buffer functions will now silently drop invalid write values rather than crashing (P.S.V.R) nodejs/node#3767.
  - This makes the behavior match what the docs suggest.
* child_process: `child.send()` now properly returns a boolean like
the docs suggest (Rich Trott) nodejs/node#3577.
* doc: All of the API docs have been re-ordered so as to read in alphabetical order (Tristian Flanagan) nodejs/node#3662.
* http_parser: update http-parser to 2.6.0 from 2.5.0 (James M
Snell) nodejs/node#3569.
  - Now supports the following HTTP methods: `LINK`, `UNLINK`, `BIND`,
`REBIND`, `UNBIND`.
  - Also added ACL and IPv6 Zone ID support.
* npm: upgrade npm to 3.3.12 from v3.3.6 (Rebecca Turner)
nodejs/node#3685.
  - See the release notes for
    https://github.com/npm/npm/releases/tag/v3.3.7,
    https://github.com/npm/npm/releases/tag/v3.3.8,
    https://github.com/npm/npm/releases/tag/v3.3.9,
    https://github.com/npm/npm/releases/tag/v3.3.10,
    https://github.com/npm/npm/releases/tag/v3.3.11, and
    https://github.com/npm/npm/releases/tag/v3.3.12 for more details.
* repl: The REPL no longer crashes if the persistent history file
cannot be opened (Evan Lucas) nodejs/node#3630.
* tls: The default `sessionIdContext` now uses SHA1 in FIPS mode rather than MD5 (Stefan Budeanu) nodejs/node#3755.
* v8: Added some more useful post-mortem data (Fedor Indutny) nodejs/node#3779.

PR-URL: nodejs/node#3736
@targos targos mentioned this pull request Mar 23, 2016
Closed
@aliscco aliscco mentioned this pull request Jun 23, 2023
Open
@aliscco aliscco mentioned this pull request Nov 29, 2023
Open
@leonardoadame leonardoadame mentioned this pull request Mar 22, 2024
Open
@aliscco aliscco mentioned this pull request Mar 23, 2024
Open
@aliscco aliscco mentioned this pull request May 15, 2024
Open
@leonardoadame leonardoadame mentioned this pull request May 23, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@jasnell jasnell

Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@tflanagan @Fishrock123 @jasnell @Qard @evanlucas @MylesBorins