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: formatting issues for child_process docs #6911

Closed
mscdex opened this issue May 21, 2016 · 8 comments
Closed

doc: formatting issues for child_process docs #6911

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

Comments

@mscdex
Copy link
Contributor

mscdex commented May 21, 2016

  • Version: v5.11.0+
  • Platform: n/a
  • Subsystem: doc, child_process

There are some formatting issues for exec() and execFile() in the child_process docs. Specifically:

  • f85412d erroneously added a backslash in front of an asterisk that was already contained within backticks. This causes the backslash to show up when rendered. The backslash can be safely removed. Fixed by ed11ac6.
  • The maxBuffer link is not styled like the other properties listed and looks out of place. My suggestion would be to have <code>-wrapped content within links to continue to have the same gray background color normally, but switch to the green background color on hover like normal links. There may be other instances of this in the docs, I have not checked.
@mscdex mscdex added child_process Issues and PRs related to the child_process subsystem. doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors. labels May 21, 2016
@rodmachen
Copy link
Contributor

I'm starting work on this issue.

cc: @evanlucas

@lance
Copy link
Member

lance commented May 24, 2016

@rodmachen Sorry! Seems there was a race condition here.

@rodmachen
Copy link
Contributor

I have fixed the "backslash in backticks" issue and that commit is included in the PR.

The maxBuffer links are a larger question. Do we need to review styling of such links across all docs? Is this styling issue that needs to be broken out and worked on independently?

I'm open to suggestions.

@mscdex
Copy link
Contributor Author

mscdex commented May 24, 2016

/cc @nodejs/documentation What does everyone think about the current styling of backtick-enclosed links?

eljefedelrodeodeljefe pushed a commit that referenced this issue May 24, 2016
Ref: #6911
Ref: #5075

PR-URL: #6952
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
Fishrock123 pushed a commit to Fishrock123/node that referenced this issue May 30, 2016
Ref: nodejs#6911
Ref: nodejs#5075

PR-URL: nodejs#6952
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
rvagg pushed a commit that referenced this issue Jun 2, 2016
Ref: #6911
Ref: #5075

PR-URL: #6952
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
@tanujasawant
Copy link
Contributor

tanujasawant commented Oct 7, 2016

May I work on this if there's more work to be done?
Everything about maxBuffer seems fine except its appearance in the link is different because of <code>

@jasnell
Copy link
Member

jasnell commented May 30, 2017

@mscdex ... still an issue?

@mscdex
Copy link
Contributor Author

mscdex commented May 30, 2017

@jasnell This specific instance was fixed in ea5a2f4. But I think the general issue regarding the current styling of backtick-enclosed links may still be valid.

@maclover7
Copy link
Contributor

Going to close out this issue since the maxBuffer specific problem was fixed. Please feel free to open a new issue regarding backtick-enclosed links if still necessary!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
child_process Issues and PRs related to the child_process subsystem. doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors.
Projects
None yet
Development

No branches or pull requests

6 participants