doc: unify more headings #20046
Closed
doc: unify more headings #20046
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vsemozhetbyt
added
the
fast-track
trivikr
approved these changes
Apr 15, 2018
There was a problem hiding this comment.
More backticks need to be removed from headings under Implementation Considerations
|
@trivikr I've seen them, but abstained from deletion: these are not formal API sections, just extra notes about previously described API. The similar cases are these subsections: https://github.com/nodejs/node/blob/master/doc/api/async_hooks.md#type They describe parameters from the previous formal signature in more details. All these should not be parsed by, say, JSON doctools as formal API parts, just as misc sections. |
BridgeAR
approved these changes
Apr 15, 2018
BridgeAR
added
the
author ready
|
Landed in 6e869be |
vsemozhetbyt
added a commit
that referenced
this pull request
Apr 16, 2018
PR-URL: #20046 Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
Apr 16, 2018
PR-URL: #20046 Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
BridgeAR
pushed a commit
to BridgeAR/node
that referenced
this pull request
May 1, 2018
PR-URL: nodejs#20046 Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesnewfor a constructor, remove()from a class name).Also in passing: