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.

Sign up for GitHub

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

Jump to bottom

Fix error and waring in make doc #4537

Closed
wants to merge 2 commits into from
Closed

Fix error and waring in make doc #4537

wants to merge 2 commits into from

Conversation

shigeki
Copy link
Contributor

@shigeki shigeki commented Jan 5, 2016

#4370 causes an error of checking the depth of heading level in buffer api doc during make doc as

/home/ohtsu/github/node/tools/doc/generate.js:52
        if (er) throw er;
                ^

Error: Inappropriate heading level
{"type":"heading","depth":3,"text":"Buffers and Character Encodings"}
    at /home/ohtsu/github/node/tools/doc/html.js:192:17
    at Array.forEach (native)
    at buildToc (/home/ohtsu/github/node/tools/doc/html.js:189:9)
    at render (/home/ohtsu/github/node/tools/doc/html.js:71:3)
    at /home/ohtsu/github/node/tools/doc/html.js:37:7
    at tryToString (fs.js:414:3)
    at FSReqWrap.readFileAfterClose [as oncomplete] (fs.js:401:12)
make: *** [out/doc/api/all.html] Error 1

This just changes error headings of the sections to the 2nd level.

And I also found that warning was shown from json.js as

Warning: invalid param "end]"
 > {"textRaw":"`end` Number, Optional, Default: `buffer.length` ","name":"end","desc":"Number, Optional, Default: `buffer.length`"}
 > buf.slice([start[, end]])

This is due to insufficient trimming of right square brackets and it is fixed.

R= @jasnell

Shigeki Ohtsu added 2 commits January 5, 2016 18:22
doc: fix heading level error in Buffer doc
e4e46de 
tools/doc/html.js in make doc throws an error in checking a heading
level in the markdown file.
tools: fix warning in doc parsing
6cc433f 
The description of "[start[, end]]" in the doc shows warning of
"invalid param" when parsing an optional parameter in the section.
This fixes insufficient trimming of right square brackets.
@shigeki shigeki added doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. labels Jan 5, 2016
@jasnell
Copy link
Member

jasnell commented Jan 5, 2016

LGTM

1 similar comment
@cjihrig
Copy link
Contributor

cjihrig commented Jan 5, 2016

LGTM

shigeki pushed a commit that referenced this pull request Jan 5, 2016
@jasnell
doc: fix heading level error in Buffer doc
64e294a 
tools/doc/html.js in make doc throws an error in checking a heading
level in the markdown file.

PR-URL: #4537
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
shigeki pushed a commit that referenced this pull request Jan 5, 2016
@jasnell
tools: fix warning in doc parsing
05f17db 
The description of "[start[, end]]" in the doc shows warning of
"invalid param" when parsing an optional parameter in the section.
This fixes insufficient trimming of right square brackets.

PR-URL: #4537
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@jasnell
Copy link
Member

jasnell commented Jan 5, 2016

Landed in 64e294a and 05f17db

@jasnell jasnell closed this Jan 5, 2016
Fishrock123 pushed a commit to Fishrock123/node that referenced this pull request Jan 6, 2016
@Fishrock123
doc: fix heading level error in Buffer doc
334e739 
tools/doc/html.js in make doc throws an error in checking a heading
level in the markdown file.

PR-URL: nodejs#4537
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Fishrock123 pushed a commit to Fishrock123/node that referenced this pull request Jan 6, 2016
@Fishrock123
tools: fix warning in doc parsing
ca9812c 
The description of "[start[, end]]" in the doc shows warning of
"invalid param" when parsing an optional parameter in the section.
This fixes insufficient trimming of right square brackets.

PR-URL: nodejs#4537
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Jan 15, 2016
Closed
@MylesBorins
Copy link
Contributor

I have backported 05f17db but not 64e294a.

64e294a is a doc fix change that is no longer relevant in LTS

@MylesBorins
Copy link
Contributor

Actually I have opted to back out 05f17db

This will land when #4370 does

@MylesBorins MylesBorins mentioned this pull request Jan 28, 2016
Closed
MylesBorins pushed a commit that referenced this pull request Feb 22, 2016
tools: fix warning in doc parsing
b7ef644 
The description of "[start[, end]]" in the doc shows warning of
"invalid param" when parsing an optional parameter in the section.
This fixes insufficient trimming of right square brackets.

PR-URL: #4537
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
MylesBorins pushed a commit that referenced this pull request Feb 22, 2016
doc: fix heading level error in Buffer doc
5d14848 
tools/doc/html.js in make doc throws an error in checking a heading
level in the markdown file.

PR-URL: #4537
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
MylesBorins pushed a commit that referenced this pull request Feb 22, 2016
tools: fix warning in doc parsing
9237b6e 
The description of "[start[, end]]" in the doc shows warning of
"invalid param" when parsing an optional parameter in the section.
This fixes insufficient trimming of right square brackets.

PR-URL: #4537
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
MylesBorins pushed a commit that referenced this pull request Feb 22, 2016
doc: fix heading level error in Buffer doc
c549ca3 
tools/doc/html.js in make doc throws an error in checking a heading
level in the markdown file.

PR-URL: #4537
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
MylesBorins pushed a commit that referenced this pull request Mar 2, 2016
tools: fix warning in doc parsing
88293f2 
The description of "[start[, end]]" in the doc shows warning of
"invalid param" when parsing an optional parameter in the section.
This fixes insufficient trimming of right square brackets.

PR-URL: #4537
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
MylesBorins pushed a commit that referenced this pull request Mar 2, 2016
doc: fix heading level error in Buffer doc
8c4748f 
tools/doc/html.js in make doc throws an error in checking a heading
level in the markdown file.

PR-URL: #4537
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
scovetta pushed a commit to scovetta/node that referenced this pull request Apr 2, 2016
doc: fix heading level error in Buffer doc
f0cd3f4 
tools/doc/html.js in make doc throws an error in checking a heading
level in the markdown file.

PR-URL: nodejs#4537
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
scovetta pushed a commit to scovetta/node that referenced this pull request Apr 2, 2016
tools: fix warning in doc parsing
8247770 
The description of "[start[, end]]" in the doc shows warning of
"invalid param" when parsing an optional parameter in the section.
This fixes insufficient trimming of right square brackets.

PR-URL: nodejs#4537
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@shigeki @jasnell @cjihrig @MylesBorins @rvagg