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 order of end tags of list after heading #5874

Conversation

firedfox
Copy link
Contributor

Pull Request check-list

Please make sure to review and check all of these items:

  • Does make -j8 test (UNIX) or vcbuild test nosign (Windows) pass with
    this change (including linting)?
  • Is the commit message formatted according to CONTRIBUTING.md?
  • If this change fixes a bug (or a performance problem), is a regression
    test (or a benchmark) included?
  • Is a documentation update included (if this change modifies
    existing APIs, or introduces new ones)?

NOTE: these things are not required to open a PR and can be done
afterwards / while the PR is open.

Affected core subsystem(s)

Please provide affected core subsystem(s) (like buffer, cluster, crypto, etc)

  • doc

Description of change

Please provide a description of the change here.

fixes #5873

Current html result of a list after heading is <div
class="signature"><ul>...</div></ul>. Correct it to <div
class="signature"><ul>...</ul></div>.
@jasnell jasnell added the doc Issues and PRs related to the documentations. label Mar 23, 2016
@jasnell
Copy link
Member

jasnell commented Mar 23, 2016

@nodejs/documentation

@benjamingr
Copy link
Member

Very nice :) Mind adding a test?

@firedfox
Copy link
Contributor Author

I checked the differences of both results of the conversions for doc/api/*, before and after my modification. The only changes are from </div></ul> to </ul></div>. Could this be enough?
If not, I'd really like to add a test. Though I'm not sure how to write it for now :P

@silverwind
Copy link
Contributor

LGTM with or without a test. I'm not sure if there are even tests for the doc tool.

@benjamingr
Copy link
Member

Yeah, I just realized that there are no tests for the doc tool, I just assumed there were - sorry for the miscommunication.

@mscdex mscdex added the tools Issues and PRs related to the tools directory. label Mar 23, 2016
@silverwind
Copy link
Contributor

Thanks! Landed in 57a4dd9.

@silverwind silverwind closed this Mar 24, 2016
silverwind pushed a commit that referenced this pull request Mar 24, 2016
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 <me@silverwind.io>
evanlucas pushed a commit that referenced this pull request Mar 30, 2016
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 <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Mar 30, 2016
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 <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Mar 30, 2016
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 <me@silverwind.io>
evanlucas pushed a commit that referenced this pull request Mar 31, 2016
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 <me@silverwind.io>
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. tools Issues and PRs related to the tools directory.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The order of end tags of list after heading in HTML doc is wrong
6 participants