Skip to content

doc: improve napi formatting #30772

New issue

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

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

Already on GitHub? # to your account

Closed
wants to merge 2 commits into from
Closed

Conversation

BridgeAR
Copy link
Member

@BridgeAR BridgeAR commented Dec 3, 2019

This addresses two nits:

  1. Bullet points that span over multiple lines should be indented
    consitently. Otherwise they are not always properly highlighted.
  2. Lines breaks after titles improve the readability.
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

This addresses two nits:

1. Bullet points that span over multiple lines should be indented
   consitently. Otherwise they are not always properly highlighted.
2. Lines breaks after titles improve the readability.
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API. labels Dec 3, 2019
@BridgeAR
Copy link
Member Author

BridgeAR commented Dec 3, 2019

@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 3, 2019
Trott pushed a commit that referenced this pull request Dec 5, 2019
This addresses two nits:

1. Bullet points that span over multiple lines should be indented
   consitently. Otherwise they are not always properly highlighted.
2. Lines breaks after titles improve the readability.

PR-URL: #30772
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@Trott
Copy link
Member

Trott commented Dec 5, 2019

Landed in e85471d

@Trott Trott closed this Dec 5, 2019
targos pushed a commit that referenced this pull request Dec 9, 2019
This addresses two nits:

1. Bullet points that span over multiple lines should be indented
   consitently. Otherwise they are not always properly highlighted.
2. Lines breaks after titles improve the readability.

PR-URL: #30772
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Dec 13, 2019
targos pushed a commit that referenced this pull request Jan 13, 2020
This addresses two nits:

1. Bullet points that span over multiple lines should be indented
   consitently. Otherwise they are not always properly highlighted.
2. Lines breaks after titles improve the readability.

PR-URL: #30772
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@BridgeAR BridgeAR deleted the fix-doc-nits branch January 20, 2020 12:06
BethGriggs pushed a commit that referenced this pull request Feb 6, 2020
This addresses two nits:

1. Bullet points that span over multiple lines should be indented
   consitently. Otherwise they are not always properly highlighted.
2. Lines breaks after titles improve the readability.

PR-URL: #30772
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Feb 8, 2020
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants