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

Path Documentation Syntax Fixes #7817

Closed
wants to merge 1 commit into from
Closed

Path Documentation Syntax Fixes #7817

wants to merge 1 commit into from

Conversation

joeycozza
Copy link
Contributor

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

Documentation for the Path module

Description of change

The single quote in the ```text area was causing the words after it to
be orange, when that probably isn't what was wanted. This issue doesn't
occur on github's markdown renderer, but it does exist on the Node
official website's docs.

screen shot 2016-07-20 at 11 43 30 pm

This fix makes is so escaping a quote in a text block isnt necessary

The single quote in the ```text area was causing the words after it to
be orange, when that probably isn't what was wanted. This issue doesn't
occur on github's markdown renderer, but it does exist on the Node
official website's docs.

This fix makes is so escaping a quote in a text block isnt necessary
@claudiorodriguez claudiorodriguez added doc Issues and PRs related to the documentations. path Issues and PRs related to the path subsystem. labels Jul 21, 2016
@claudiorodriguez
Copy link
Contributor

LGTM, just need to change the first line of the commit message to doc: ... but that can be done when landing

@cjihrig
Copy link
Contributor

cjihrig commented Jul 21, 2016

LGTM

1 similar comment
@jasnell
Copy link
Member

jasnell commented Jul 29, 2016

LGTM

@cjihrig
Copy link
Contributor

cjihrig commented Aug 1, 2016

Landed in 65a42ab. Thanks!

@cjihrig cjihrig closed this Aug 1, 2016
cjihrig pushed a commit that referenced this pull request Aug 1, 2016
Single quotes in two of the examples were throwing off the
formatting of the path documentation on the Node.js website. This
commit expands two contractions to remove the offending quotes.

PR-URL: #7817
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Claudio Rodriguez <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@cjihrig cjihrig mentioned this pull request Aug 8, 2016
cjihrig pushed a commit that referenced this pull request Aug 10, 2016
Single quotes in two of the examples were throwing off the
formatting of the path documentation on the Node.js website. This
commit expands two contractions to remove the offending quotes.

PR-URL: #7817
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Claudio Rodriguez <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@cjihrig cjihrig mentioned this pull request Aug 11, 2016
@squarejaw squarejaw mentioned this pull request Oct 5, 2016
2 tasks
Fishrock123 pushed a commit that referenced this pull request Oct 5, 2016
Tangentially related to #7817

PR-URL: #8933
Reviewed-By: Brian White <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Claudio Rodriguez <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
jasnell pushed a commit that referenced this pull request Oct 6, 2016
Tangentially related to #7817

PR-URL: #8933
Reviewed-By: Brian White <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Claudio Rodriguez <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Fishrock123 pushed a commit that referenced this pull request Oct 11, 2016
Tangentially related to #7817

PR-URL: #8933
Reviewed-By: Brian White <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Claudio Rodriguez <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[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. path Issues and PRs related to the path subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants