http2: Correcting the heading format#22262
Uh oh!
There was an error while loading. Please reload this page.
Conversation
nodejs-github-bot added doc 
trivikr commented Aug 11, 2018
trivikr added the author ready 
Trott commented Aug 11, 2018
@vsemozhetbyt@rubys (just to get the eyes of the people most familiar with our current markdown processing quirks and bugs) |
vsemozhetbyt commented Aug 11, 2018
This is indeed a regression in the new toolchain, but it should be fixed eventually in the #22140 (checked and confirmed in #22140 (comment)) |
We usually do not use backticks in API headings (when all the heading needs to be wrapped in backticks) and do use them for code entities in common headings. |
gdams commented Aug 14, 2018
@antsmartian can you please resolve the conflicts? |
doc/api/http2.md Outdated
There was a problem hiding this comment.
Is moving the heading intentional? It seems the next paragraph is out of topic now?
There was a problem hiding this comment.
Nope, I tried to resolve conflicts via browser and things didn't went well.
There was a problem hiding this comment.
I will squash my commits and update the PR.
antsmartianforce-pushed the http2_doc_fix branch from c3565d7 to ae7922fCompare
antsmartianforce-pushed the http2_doc_fix branch from 80cf121 to 6889fc1Compare
antsmartian commented Aug 14, 2018
@vsemozhetbyt Now it should be good to go. cc @gdams fixed the conflicts. |
gdams commented Aug 14, 2018
gdams commented Aug 14, 2018
landed in: fc84666 |
PR-URL: #22262 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: George Adams <[email protected]>
PR-URL: #22262 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: George Adams <[email protected]>
PR-URL: nodejs/node#22262 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: George Adams <[email protected]>
7 participants
Was reading http2 docs and found this issue. Looks like a heading doesn't need code tags (``).
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes