Repository navigation
doc: formatting issues for child_process docs #6911
Description
- 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
maxBufferlink 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.
Activity
rodmachen commentedon May 24, 2016
I'm starting work on this issue.
cc: @evanlucas
lance commentedon May 24, 2016
@rodmachen Sorry! Seems there was a race condition here.
rodmachen commentedon May 24, 2016
I have fixed the "backslash in backticks" issue and that commit is included in the PR.
The
maxBufferlinks 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 commentedon May 24, 2016
/cc @nodejs/documentation What does everyone think about the current styling of backtick-enclosed links?
doc: remove "\" within backticks
doc: remove "\" within backticks
doc: remove "\" within backticks
tanujasawant commentedon Oct 7, 2016
May I work on this if there's more work to be done?
Everything about
maxBufferseems fine except its appearance in the link is different because of<code>jasnell commentedon May 30, 2017
@mscdex ... still an issue?
mscdex commentedon 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 commentedon Nov 26, 2017
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!