Skip to content

doc: remove wrong escapes#29452

Closed
XhmikosR wants to merge 1 commit into
nodejs:masterfrom
XhmikosR:master-xmr-doc-escapes
Closed

doc: remove wrong escapes#29452
XhmikosR wants to merge 1 commit into
nodejs:masterfrom
XhmikosR:master-xmr-doc-escapes

Conversation

@XhmikosR

@XhmikosR XhmikosR commented Sep 5, 2019

Copy link
Copy Markdown
Contributor
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

I noticed these in the nodejs.org repo and thought I'd fix them here too.

This should probably be automated, but I don't have the bandwidth to do this myself. Also, I'm not quite sure if this can be safely automated, since there are cases one needs to use \ (for example WIndows paths).

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Sep 5, 2019
@trivikr

trivikr commented Sep 5, 2019

Copy link
Copy Markdown
Member

Are these escapes automatically added on new releases? If yes, can they be ignored/avoided?

Example commit for 12.10.0 02c74e7
Line which has escape: Add \*timeNs properties to BigInt Stats objects (Joyee Cheung)
Corresponding commit doesn't have escape b245257

@XhmikosR

XhmikosR commented Sep 6, 2019

Copy link
Copy Markdown
Contributor Author

If you mean \*timeNs there it's needed because it's not wrapped in code thus * needs to be escaped.

@Trott

Trott commented Sep 7, 2019

Copy link
Copy Markdown
Member

@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Sep 7, 2019
@Trott

Trott commented Sep 8, 2019

Copy link
Copy Markdown
Member

Trott pushed a commit that referenced this pull request Sep 8, 2019
PR-URL: #29452
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@Trott

Trott commented Sep 8, 2019

Copy link
Copy Markdown
Member

Landed in ab05d43

@Trott Trott closed this Sep 8, 2019
@XhmikosR XhmikosR deleted the master-xmr-doc-escapes branch September 9, 2019 04:04
targos pushed a commit that referenced this pull request Sep 20, 2019
PR-URL: #29452
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@BridgeAR BridgeAR mentioned this pull request Sep 24, 2019
BridgeAR pushed a commit that referenced this pull request Sep 25, 2019
PR-URL: #29452
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants