Skip to content

tools: improve section tag additions in HTML doc generator - #41318

Merged
nodejs-github-bot merged 1 commit into
nodejs:masterfrom
Trott:edge-case
Dec 27, 2021
Merged

tools: improve section tag additions in HTML doc generator#41318
nodejs-github-bot merged 1 commit into
nodejs:masterfrom
Trott:edge-case

Conversation

@Trott

Copy link
Copy Markdown
Member

There is an edge case involving GFM footnotes where our current code
adds an empty section which results in a warning (but not an error) in
HTML validators. This change causes the HTML generator to skip the
unnecessary addition of a section tag in that one edge case.

There is an edge case involving GFM footnotes where our current code
adds an empty section which results in a warning (but not an error) in
HTML validators. This change causes the HTML generator to skip the
unnecessary addition of a section tag in that one edge case.
@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. labels Dec 25, 2021
@Trott

Trott commented Dec 25, 2021

Copy link
Copy Markdown
MemberAuthor

The diff of changes in the docs that result from the change in this PR is a single line in webcrypto.html (and the corresponding line in all.html). Here's the diff:

2736c2736< <section data-footnotes="" class="footnotes"></section><section><h3 id="footnote-label" class="sr-only">Footnotes</h3>---> <section data-footnotes="" class="footnotes"><h3 id="footnote-label" class="sr-only">Footnotes</h3>

This is exactly the change I was trying to make.

@aduh95aduh95 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 25, 2021
@aduh95aduh95 added the commit-queue Add this label to land a pull request using GitHub Actions. label Dec 27, 2021
@nodejs-github-botnodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Dec 27, 2021
@TrottTrott added the commit-queue Add this label to land a pull request using GitHub Actions. label Dec 27, 2021
@nodejs-github-botnodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Dec 27, 2021
@nodejs-github-bot
nodejs-github-bot merged commit e4aa575 into nodejs:masterDec 27, 2021
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in e4aa575

@Trott
Trott deleted the edge-case branch December 27, 2021 20:47
targos pushed a commit that referenced this pull request Jan 14, 2022
There is an edge case involving GFM footnotes where our current code
adds an empty section which results in a warning (but not an error) in
HTML validators. This change causes the HTML generator to skip the
unnecessary addition of a section tag in that one edge case.
PR-URL: #41318
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
@targostargos mentioned this pull request Jan 16, 2022
danielleadams pushed a commit that referenced this pull request Jan 31, 2022
There is an edge case involving GFM footnotes where our current code
adds an empty section which results in a warning (but not an error) in
HTML validators. This change causes the HTML generator to skip the
unnecessary addition of a section tag in that one edge case.
PR-URL: #41318
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
danielleadams pushed a commit that referenced this pull request Feb 1, 2022
There is an edge case involving GFM footnotes where our current code
adds an empty section which results in a warning (but not an error) in
HTML validators. This change causes the HTML generator to skip the
unnecessary addition of a section tag in that one edge case.
PR-URL: #41318
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
@danielleadamsdanielleadams mentioned this pull request Feb 1, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.toolsIssues and PRs related to the tools directory.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@Trott@nodejs-github-bot@tniessen@aduh95@VoltrexKeyva