doc: normalize C code block info strings#33507
doc: normalize C code block info strings#33507DerekNonGeneric wants to merge 1 commit intonodejs:masterfrom DerekNonGeneric:normalize-c-info-strings
Conversation
|
I've inspected the contents of the highlight.js bundle, and |
|
That's because it's new (as a language) though I'm pretty sure it's always existed as an alias of |
|
@nodejs/n-api @nodejs/documentation PTAL |
Prior to this commit, C fenced code blocks in Markdown files had inconsistent info strings. This has been corrected to standardize on the lowercase variant, which matches the others, is the typical file extension for C files, and is the CSS class used by highlight.js despite representing a minority of appearances in the doc/api/ dir. Stats: > 'C' => 181, > 'c' => 3, Refs: highlightjs/highlight.js#2577
|
@yyyc514, thanks for the tip! From what I gather, C and C++ use the same foundation grammar, so there's no real reason to make the distinction between the two since there's no observable difference. Is that right? I'm just a bit unclear if the info string for these should be |
addaleax
left a comment
There was a problem hiding this comment.
I would keep C and C++ separate, they are different, not fully mutually compatible languages after all.
For now. But the intent is they diverge over time. So use the correct one. Future proof. H is just an alias for C. |
Prior to this commit, C fenced code blocks in Markdown files had inconsistent info strings. This has been corrected to standardize on the lowercase variant, which matches the others, is the typical file extension for C files, and is the CSS class used by highlight.js despite representing a minority of appearances in the doc/api/ dir. Stats: > 'C' => 181, > 'c' => 3, Refs: highlightjs/highlight.js#2577 PR-URL: nodejs#33507 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
|
Landed in 84e4425 |
Prior to this commit, C fenced code blocks in Markdown files had inconsistent info strings. This has been corrected to standardize on the lowercase variant, which matches the others, is the typical file extension for C files, and is the CSS class used by highlight.js despite representing a minority of appearances in the doc/api/ dir. Stats: > 'C' => 181, > 'c' => 3, Refs: highlightjs/highlight.js#2577 PR-URL: #33507 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This commit adds the list of agreed-upon info strings to the documentation style guide to aid with future development and maintenance. Refs: #33510 Refs: #33507 Refs: #33483 Refs: #33531 Refs: #33542 Refs: #33028 Refs: #33548 Refs: #33486 PR-URL: #34024 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
This commit adds the list of agreed-upon info strings to the documentation style guide to aid with future development and maintenance. Refs: #33510 Refs: #33507 Refs: #33483 Refs: #33531 Refs: #33542 Refs: #33028 Refs: #33548 Refs: #33486 PR-URL: #34024 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Prior to this commit, C fenced code blocks in Markdown files had inconsistent info strings. This has been corrected to standardize on the lowercase variant, which matches the others, is the typical file extension for C files, and is the CSS class used by highlight.js despite representing a minority of appearances in the doc/api/ dir. Stats: > 'C' => 181, > 'c' => 3, Refs: highlightjs/highlight.js#2577 PR-URL: #33507 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This commit adds the list of agreed-upon info strings to the documentation style guide to aid with future development and maintenance. Refs: #33510 Refs: #33507 Refs: #33483 Refs: #33531 Refs: #33542 Refs: #33028 Refs: #33548 Refs: #33486 PR-URL: #34024 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Prior to this commit, C fenced code blocks in Markdown files had inconsistent info strings. This has been corrected to standardize on the lowercase variant, which matches the others, is the typical file extension for C files, and is the CSS class used by highlight.js despite representing a minority of appearances in the doc/api/ dir. Stats: > 'C' => 181, > 'c' => 3, Refs: highlightjs/highlight.js#2577 PR-URL: #33507 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This commit adds the list of agreed-upon info strings to the documentation style guide to aid with future development and maintenance. Refs: #33510 Refs: #33507 Refs: #33483 Refs: #33531 Refs: #33542 Refs: #33028 Refs: #33548 Refs: #33486 PR-URL: #34024 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
This commit adds the list of agreed-upon info strings to the documentation style guide to aid with future development and maintenance. Refs: #33510 Refs: #33507 Refs: #33483 Refs: #33531 Refs: #33542 Refs: #33028 Refs: #33548 Refs: #33486 PR-URL: #34024 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
This commit adds the list of agreed-upon info strings to the documentation style guide to aid with future development and maintenance. Refs: #33510 Refs: #33507 Refs: #33483 Refs: #33531 Refs: #33542 Refs: #33028 Refs: #33548 Refs: #33486 PR-URL: #34024 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Prior to this commit, C fenced code blocks in Markdown files had
inconsistent info strings. This has been corrected to standardize on
the lowercase variant, which matches the others, is the typical file
extension for C files, and is the CSS class used by highlight.js
despite representing a minority of appearances in the doc/api/ dir.
Stats:
Refs: highlightjs/highlight.js#2577
Checklist