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: process formatting issues #9223

Closed
mscdex opened this issue Oct 21, 2016 · 0 comments
Closed

doc: process formatting issues #9223

mscdex opened this issue Oct 21, 2016 · 0 comments
Labels
doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors. process Issues and PRs related to the process subsystem.

Comments

@mscdex
Copy link
Contributor

mscdex commented Oct 21, 2016

  • Version: master, v6.x
  • Platform: n/a
  • Subsystem: doc

I noticed there are some markdown formatting issues with the process documentation:

  • There is a missing backtick in the description for process.setuid() after process.setuid(id).
  • There are some missing link references: here (process.exitCode), here (process.exitCode), and here (LTS).
  • In the process.release section, there are some instances of markdown underscores for italicization showing up literally in file names/extensions: _.tar.gz_ (2) and _node.lib_ (1). I think if the underscores are moved right outside the backticks, the italics should render correctly.
@mscdex mscdex added doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors. process Issues and PRs related to the process subsystem. labels Oct 21, 2016
rodmachen pushed a commit to rodmachen/node that referenced this issue Oct 22, 2016
Fixes several formatting errors in the process doc, including missing
link references, misplaced underscores, and a missing backtick.

Fixes: nodejs#9223
jasnell pushed a commit that referenced this issue Oct 24, 2016
Fixes several formatting errors in the process doc, including missing
link references, misplaced underscores, and a missing backtick.

Fixes: #9223
PR-URL: #9235
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Brian White <[email protected]>
MylesBorins pushed a commit that referenced this issue Nov 17, 2016
Fixes several formatting errors in the process doc, including missing
link references, misplaced underscores, and a missing backtick.

Fixes: #9223
PR-URL: #9235
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Brian White <[email protected]>
MylesBorins pushed a commit that referenced this issue Nov 19, 2016
Fixes several formatting errors in the process doc, including missing
link references, misplaced underscores, and a missing backtick.

Fixes: #9223
PR-URL: #9235
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Brian White <[email protected]>
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. good first issue Issues that are suitable for first-time contributors. process Issues and PRs related to the process subsystem.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant