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.

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

doc: fix sorting in API references #11331

Closed
wants to merge 1 commit into from

Conversation

@vsemozhetbyt
Copy link
Contributor

commented Feb 13, 2017

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

Some chapters in the API lists were out of alphabetical order due to different adding time or preferring logical order (open before close, unref() next to ref() and so on). However, docs prefer alphabetical order in the most cases, so such exceptions could be confusing and could prevent a reader from finding a needed chapter.

I've abstained from changing an unalphabetical order in two docs: cli.md (it seems to be mostly logical) and zlib.md (due to only one description for async and sync pairs of "Convenience Methods").

Relocated chapters (because of mutual relocations some other ones could seem relocated too):

buffer.md
new Buffer(arrayBuffer[, byteOffset [, length]])
(compare the place of: Class Method: Buffer.from(arrayBuffer[, byteOffset[, length]]))
buf.includes(value[, byteOffset][, encoding])
buf.toJSON()

crypto.md
crypto.timingSafeEqual(a, b)

dns.md
dns.resolvePtr(hostname, callback)

domain.md
many

fs.md
Class: fs.ReadStreamEvent: 'close'
Class: fs.WriteStreamEvent: 'close'

http.md
message.socket

process.md
process.env

tls.md
Class: tls.ServerEvent: 'tlsClientError'
Class: tls.TLSSockettlsSocket.authorized
tls.connect(port[, host][, options][, callback])
tls.connect(path[, options][, callback])

dgram.md
socket.ref()

url.md
many of urlObject.*

util.md
util.inspect.custom
util._extend(target, source)

v8.md
v8.getHeapSpaceStatistics()

You can easily see these order violations in the tables of content from the relevant .html files.

@Trott

This comment has been minimized.

Copy link
Member

commented Feb 13, 2017

@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

commented Feb 18, 2017

@nodejs/documentation It seems, this PR is prone to constantly emerged conflicts due to a big amount of affected docs text. Also, it can cause such conflicts for other PRs. Could it be approved or closed?

@sam-github
Copy link
Member

left a comment

LGTM, but please make sure that its up-to-date before merging.

@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

commented Feb 20, 2017

@jasnell @sam-github Is "This branch has no conflicts with the base branch" a sufficient sign that it's up-to-date? If so, could it be landed with two approvals and 8 days?

@sam-github

This comment has been minimized.

Copy link
Member

commented Feb 20, 2017

@vsemozhetbyt I think a careful review by you of the diff to make sure your moved text is the same as the text you removed would be a good idea, I don't know if I perfectly trust git conflict algs here, it would be unfortunate to lose docs.

And as soon as you do that you can land it, yes, its been 8 days, with two approvals, so its good to go.

@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

commented Feb 20, 2017

@sam-github I've checked once more, it seems OK to me. However, I have not rights to land it.

@sam-github

This comment has been minimized.

Copy link
Member

commented Feb 20, 2017

@vsemozhetbyt oh, sorry, I thought that Member tag by your name meant you did. How come you aren't a collaborator, yet? Did you decline?

Anyhow, I'll land this.

@sam-github

This comment has been minimized.

Copy link
Member

commented Feb 20, 2017

Landed in 52b2536

@sam-github sam-github closed this Feb 20, 2017

sam-github added a commit that referenced this pull request Feb 20, 2017
doc: fix sorting in API references
PR-URL: #11331
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>

@vsemozhetbyt vsemozhetbyt deleted the vsemozhetbyt:doc-sort-api branch Feb 20, 2017

@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

commented Feb 20, 2017

@sam-github Thank you. Yes, Member tag is a bit confusing now. I had it after a commit in the nodejs/nodejs.org and including in a Website team. It does not mean write rights in all the repos.

addaleax added a commit to addaleax/node that referenced this pull request Feb 24, 2017
doc: fix sorting in API references
PR-URL: nodejs#11331
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
addaleax added a commit that referenced this pull request Feb 25, 2017
doc: fix sorting in API references
PR-URL: #11529
Backport-Of: #11331
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
@jasnell jasnell referenced this pull request Apr 4, 2017
@gibfahn gibfahn referenced this pull request Jun 15, 2017
2 of 3 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
7 participants
You can’t perform that action at this time.