doc: add missing type=misc top comments #20022
Closed
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
lpinca
approved these changes
Apr 14, 2018
trivikr
approved these changes
Apr 14, 2018
|
Landed in 72dc1ae |
vsemozhetbyt
added a commit
that referenced
this pull request
Apr 14, 2018
PR-URL: #20022 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
jasnell
pushed a commit
that referenced
this pull request
Apr 16, 2018
PR-URL: #20022 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
BridgeAR
pushed a commit
to BridgeAR/node
that referenced
this pull request
May 1, 2018
PR-URL: nodejs#20022 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
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) passesIf I get this right, we have two types of docs: concerning
require-able modules and other docs.Other docs usually have top level
<!-- type=misc -->comments, so that the top JSON container for them would bemiscs(compare arequire-able module doc). These docs adhere this rule:These ones seem to lack these comments:
addons,esm, andn-apidocs concern importable modules, but they are mostly tutorials, not module API docs. I may be wrong in these cases, so correct me if so.As for
tracing.md, it will become arequire-able module doc soon, so the mentioned comment is not needed there now.