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: change the 'txt' to 'console' for a command #29389

Closed
wants to merge 1 commit into from
Closed

doc: change the 'txt' to 'console' for a command #29389

wants to merge 1 commit into from

Conversation

SEWeiTung
Copy link

This is the document formation, because node is a command to be
executed, we should reguard it as a command prompt instead of a command
txt type. Notice that if this is a pure txt file of command, it should be something
like what we see in 'doc/api/tracing.md (L39-41)'.


  • 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 is the document formation, because `node` is a command to be
executed, we should reguard it as a command prompt instead of a command
txt type.
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Sep 1, 2019
Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I imagine this makes no difference in terms of rendering, but for semantics for people viewing raw markdown (which we should definitely accommodate as much as possible IMO), this is probably an improvement, so 👍 from me.

@Trott
Copy link
Member

Trott commented Sep 3, 2019

@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Sep 3, 2019
@Trott
Copy link
Member

Trott commented Sep 3, 2019

Landed in 3c84556

@Trott Trott closed this Sep 3, 2019
Trott pushed a commit to Trott/io.js that referenced this pull request Sep 3, 2019
This is the document formation, because `node` is a command to be
executed, we should reguard it as a command prompt instead of a command
txt type.

PR-URL: nodejs#29389
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@SEWeiTung SEWeiTung deleted the ChangeDocFormation branch September 4, 2019 03:18
targos pushed a commit that referenced this pull request Sep 20, 2019
This is the document formation, because `node` is a command to be
executed, we should reguard it as a command prompt instead of a command
txt type.

PR-URL: #29389
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@BridgeAR BridgeAR mentioned this pull request Sep 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in 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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants