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

The order of end tags of list after heading in HTML doc is wrong #5873

Closed
firedfox opened this issue Mar 23, 2016 · 1 comment
Closed

The order of end tags of list after heading in HTML doc is wrong #5873

firedfox opened this issue Mar 23, 2016 · 1 comment
Labels
doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory.

Comments

@firedfox
Copy link
Contributor

  • Version: v5.9.0
  • Platform: Darwin firedfox-mbp.local 15.3.0 Darwin Kernel Version 15.3.0: Thu Dec 10 18:40:58 PST 2015; root:xnu-3248.30.4~1/RELEASE_X86_64 x86_64
  • Subsystem: doc

While using generate.js to convert a list after heading into HTML, the order of end tags is wrong.

### Heading
* item

is converted to

<h3>Heading</h3>
<div class="signature"><ul>
<li>item</li>
</div></ul>

For example:

### Class Method: Buffer.from(array)
* `array` {Array}

is converted to

<h3>Class Method: Buffer.from(array)<span><a class="mark" href="#buffer_class_method_buffer_from_array" id="buffer_class_method_buffer_from_array">#</a></span></h3>
<div class="signature"><ul>
<li><code>array</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="type">&lt;Array&gt;</a></li>
</div></ul>
@firedfox firedfox mentioned this issue Mar 23, 2016
Closed
4 tasks
@jasnell jasnell added the doc Issues and PRs related to the documentations. label Mar 23, 2016
@mscdex mscdex added the tools Issues and PRs related to the tools directory. label Mar 23, 2016
@silverwind silverwind mentioned this issue Mar 30, 2016
Closed
@silverwind
Copy link
Contributor

Suggestion on preventing issues like this one in the future: #5955

@firedfox firedfox changed the title the order of end tags of list after heading in HTML doc is wrong The order of end tags of list after heading in HTML doc is wrong Mar 30, 2016
evanlucas pushed a commit that referenced this issue Mar 30, 2016
@evanlucas
doc: fix order of end tags of list after heading
b9682af 
Current html result of a list after heading is <div
class="signature"><ul>...</div></ul>. Correct it to <div
class="signature"><ul>...</ul></div>.

PR-URL: #5874
Fixes: #5873
Reviewed-By: Roman Reiss <[email protected]>
MylesBorins pushed a commit that referenced this issue Mar 30, 2016
doc: fix order of end tags of list after heading
5eb1dbf 
Current html result of a list after heading is <div
class="signature"><ul>...</div></ul>. Correct it to <div
class="signature"><ul>...</ul></div>.

PR-URL: #5874
Fixes: #5873
Reviewed-By: Roman Reiss <[email protected]>
MylesBorins pushed a commit that referenced this issue Mar 30, 2016
doc: fix order of end tags of list after heading
8c24bd2 
Current html result of a list after heading is <div
class="signature"><ul>...</div></ul>. Correct it to <div
class="signature"><ul>...</ul></div>.

PR-URL: #5874
Fixes: #5873
Reviewed-By: Roman Reiss <[email protected]>
evanlucas pushed a commit that referenced this issue Mar 31, 2016
@evanlucas
doc: fix order of end tags of list after heading
949b17f 
Current html result of a list after heading is <div
class="signature"><ul>...</div></ul>. Correct it to <div
class="signature"><ul>...</ul></div>.

PR-URL: #5874
Fixes: #5873
Reviewed-By: Roman Reiss <[email protected]>
@iankronquist iankronquist mentioned this issue Apr 4, 2016
Closed
4 tasks
iankronquist added a commit to iankronquist/io.js that referenced this issue Apr 4, 2016
@iankronquist
tools/doc: Add tests for the toHTML function
524ebc7 
Addresses nodejs#5955 on GitHub.
Test the toHTML function in html.js. Check that given valid markdown it
produces the expected html. One test case will prevent regressions of
big nodejs#5873.
iankronquist added a commit to iankronquist/io.js that referenced this issue Apr 28, 2016
@iankronquist
tools/doc: Add tests for doctool
94318cd 
Addresses nodejs#5955 on GitHub.
* Test the toHTML function in html.js. Check that given valid markdown it
produces the expected html. One test case will prevent regressions of
big nodejs#5873.
* Check that when given valid markdown toJSON produces valid JSON with the
expected schema.
* Add doctool to the list of built in tests so it runs in CI.
silverwind pushed a commit that referenced this issue Apr 28, 2016
@iankronquist @silverwind
tools: add tests for the doctool
2e845f8 
* Test the toHTML function in html.js. Check that given valid markdown
  it produces the expected html. One test case will prevent regressions
  of #5873.
* Check that when given valid markdown toJSON produces valid JSON with
  the expected schema.
* Add doctool to the list of built in tests so it runs in CI.

PR-URL: #6031
Fixes: #5955
Reviewed-By: Roman Reiss <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Fishrock123 pushed a commit that referenced this issue May 4, 2016
@iankronquist @Fishrock123
tools: add tests for the doctool
66903f6 
* Test the toHTML function in html.js. Check that given valid markdown
  it produces the expected html. One test case will prevent regressions
  of #5873.
* Check that when given valid markdown toJSON produces valid JSON with
  the expected schema.
* Add doctool to the list of built in tests so it runs in CI.

PR-URL: #6031
Fixes: #5955
Reviewed-By: Roman Reiss <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
@MylesBorins MylesBorins mentioned this issue May 10, 2016
Merged
4 tasks
MylesBorins pushed a commit that referenced this issue Jun 1, 2016
@iankronquist
tools: add tests for the doctool
85d32bd 
* Test the toHTML function in html.js. Check that given valid markdown
  it produces the expected html. One test case will prevent regressions
  of #5873.
* Check that when given valid markdown toJSON produces valid JSON with
  the expected schema.
* Add doctool to the list of built in tests so it runs in CI.

PR-URL: #6031
Fixes: #5955
Reviewed-By: Roman Reiss <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
MylesBorins pushed a commit that referenced this issue Jun 23, 2016
@iankronquist
tools: add tests for the doctool
71c601f 
* Test the toHTML function in html.js. Check that given valid markdown
  it produces the expected html. One test case will prevent regressions
  of #5873.
* Check that when given valid markdown toJSON produces valid JSON with
  the expected schema.
* Add doctool to the list of built in tests so it runs in CI.

PR-URL: #6031
Fixes: #5955
Reviewed-By: Roman Reiss <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
MylesBorins pushed a commit that referenced this issue Jun 24, 2016
@iankronquist
tools: add tests for the doctool
0f6146c 
* Test the toHTML function in html.js. Check that given valid markdown
  it produces the expected html. One test case will prevent regressions
  of #5873.
* Check that when given valid markdown toJSON produces valid JSON with
  the expected schema.
* Add doctool to the list of built in tests so it runs in CI.

PR-URL: #6031
Fixes: #5955
Reviewed-By: Roman Reiss <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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 a pull request may close this issue.

doc: fix order of end tags of list after heading firedfox/node
4 participants
@mscdex @silverwind @firedfox @jasnell