doc: unify more headings#20046
doc: unify more headings#20046vsemozhetbyt wants to merge 1 commit intonodejs:masterfrom vsemozhetbyt:doc-unify-more-headings
Conversation
trivikr
left a comment
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. |
|
Landed in 6e869be |
PR-URL: #20046 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
PR-URL: #20046 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
PR-URL: nodejs#20046 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesnewfor a constructor, remove()from a class name).Also in passing: