Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: repeated text when using superscripts #43864

Closed
kvakil opened this issue Jul 16, 2022 · 1 comment · Fixed by #43927
Closed

doc: repeated text when using superscripts #43864

kvakil opened this issue Jul 16, 2022 · 1 comment · Fixed by #43927
Labels
doc Issues and PRs related to the documentations.

Comments

@kvakil
Copy link
Contributor

kvakil commented Jul 16, 2022

Affected URL(s)

https://nodejs.org/api/http2.html

Description of the problem

The output here (and other places in the documentation) is buggy; it
says $22^{32}$ where it should say $2^{32}$:

maxReservedRemoteStreams ... The maximum allowed value is $22^{32}-1$. ...

The actual source documentation is correct:

is 0. The maximum allowed value is 2<sup>32</sup>-1. A negative value sets

This began in #36407 according to git bisect run with the following:

#!/bin/bash
rm -rf out/doc
NODE=out/Release/node make -j$(nproc) doc-only || exit 125
! grep -q '22<sup>32</sup>-1' out/doc/api/http2.html

Weirdly the issue appears localized to superscripts in lists. It looks
fine when they are not in lists.

@kvakil kvakil added the doc Issues and PRs related to the documentations. label Jul 16, 2022
@MoLow
Copy link
Member

MoLow commented Jul 17, 2022

I am taking a look

nodejs-github-bot pushed a commit that referenced this issue Jul 23, 2022
PR-URL: #43927
Fixes: #43864
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
danielleadams pushed a commit that referenced this issue Jul 26, 2022
PR-URL: #43927
Fixes: #43864
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
targos pushed a commit that referenced this issue Jul 31, 2022
PR-URL: #43927
Fixes: #43864
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
targos pushed a commit that referenced this issue Jul 31, 2022
PR-URL: #43927
Fixes: #43864
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
targos pushed a commit that referenced this issue Aug 1, 2022
PR-URL: #43927
Fixes: #43864
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Fyko pushed a commit to Fyko/node that referenced this issue Sep 15, 2022
PR-URL: nodejs#43927
Fixes: nodejs#43864
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
guangwong pushed a commit to noslate-project/node that referenced this issue Oct 10, 2022
PR-URL: nodejs/node#43927
Fixes: nodejs/node#43864
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants