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: Fix v8 doc headings so 'make doc' passes #203

Closed
wants to merge 1 commit into from

Conversation

markstos
Copy link
Contributor

Previously the code that builds the Table of Contents threw
an exception because of jump from an H1 heading directly to an H3
heading. This happened when running make doc.

By changing the H3 heading to an H2, 'make doc' works again. This is
also consistent with other docs like console.markdown which use
H2 for method call documentation.

Previously the code that builds the Table of Contents threw
an exception because of jump from an H1 heading directly to an H3
heading.

By changing the H3 heading to an H2, 'make doc' works again. This is
also consistent with other docs like console.markdown which use
H2 for method call documentation.
bnoordhuis pushed a commit that referenced this pull request Dec 23, 2014
Previously the code that builds the Table of Contents threw
an exception because of jump from an H1 heading directly to an H3
heading.

By changing the H3 heading to an H2, 'make doc' works again. This is
also consistent with other docs like console.markdown which use
H2 for method call documentation.

PR-URL: #203
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
@bnoordhuis
Copy link
Member

Oops and mea culpa, I guess I broke that when I converted the documentation for the tracing module. Landed in 0a8e987, thanks!

@bnoordhuis bnoordhuis closed this Dec 23, 2014
@markstos markstos deleted the fix-v8-doc-headings branch December 23, 2014 16:30
jasongin added a commit to jasongin/nodejs that referenced this pull request Mar 28, 2017
 - Add an env parameter to napi_finalize
 - Remove unnecessary reinterpret_cast<> calls
 - Remove redundant Maybe.IsNothing() checks
 - Make function call result parameters optional
 - Wrap internal field pointer values in External
 - Fix broken callback tests and add error-checking
 - Other misc test cleanup
boingoing pushed a commit to boingoing/node that referenced this pull request Apr 6, 2017
 - Add an env parameter to napi_finalize
 - Remove unnecessary reinterpret_cast<> calls
 - Remove redundant Maybe.IsNothing() checks
 - Make function call result parameters optional
 - Wrap internal field pointer values in External
 - Fix broken callback tests and add error-checking
 - Other misc test cleanup
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants