Skip to content

Path Documentation Syntax Fixes #7817

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.

Sign up for GitHub

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

Closed
joeycozza wants to merge 1 commit into from
Closed

Path Documentation Syntax Fixes #7817

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Path Documentation Syntax Fixes 
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
  • Loading branch information
@joeycozza
joeycozza committed Jul 21, 2016
commit d4b79b23ffa7fc8a8d4caa22a39c4e0fba5249e1
4 changes: 2 additions & 2 deletions doc/api/path.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ path.parse('/home/user/dir/file.txt')
│ root │ │ name │ ext │
" / home/user/dir / file .txt "
└──────┴──────────────┴──────┴─────┘
(all spaces in the "" line should be ignored -- they're purely for formatting)
(all spaces in the "" line should be ignored -- they are purely for formatting)
```

On Windows:
Expand All @@ -391,7 +391,7 @@ path.parse('C:\\path\\dir\\file.txt')
│ root │ │ name │ ext │
" C:\ path\dir \ file .txt "
└──────┴──────────────┴──────┴─────┘
(all spaces in the "" line should be ignored -- they're purely for formatting)
(all spaces in the "" line should be ignored -- they are purely for formatting)
```

A [`TypeError`][] is thrown if `path` is not a string.
Expand Down