FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: normalize plaintext code blocks by zeke · Pull Request #33028 · nodejs/node · GitHub

/ node Public

docs: normalize plaintext code blocks - #33028

Closed
zeke wants to merge 16 commits into
nodejs:masterfrom
zeke:normalize-plaintext-code-blocks
ConversationCommits (16)ChecksFiles changed
Closed

docs: normalize plaintext code blocks#33028
zeke wants to merge 16 commits into
nodejs:masterfrom
zeke:normalize-plaintext-code-blocks

Conversation

zeke commented Apr 23, 2020

Copy link
Copy Markdown
Contributor

The PR normalizes txt, fundamental, and raw fenced code blocks in markdown files to use text as the info string (i.e. language).

Resolves #32938

Checklist

cc @nodejs/documentation

nodejs-github-bot added the doc Issues and PRs related to the documentations. label Apr 23, 2020
DerekNonGeneric reviewed Apr 23, 2020
View reviewed changes
Comment thread doc/api/report.md Outdated
zeke mentioned this pull request Apr 23, 2020
Closed
5 tasks
DerekNonGeneric reviewed Apr 24, 2020
View reviewed changes
Comment thread doc/api/http2.md Outdated
zeke commented Apr 24, 2020
View reviewed changes
Comment thread doc/api/http2.md Outdated

DerekNonGeneric commented Apr 24, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor

@zeke, I have a couple of concerns w/ your PR. The primary one being that we aren't nipping this in the bud. Ideally, we would be banning the txt info string while providing a suggestion for text. This would happen in remark-preset-lint-node. I fear you may have jumped the gun on this one and would have to defer further work on this PR until @Trott has made some comments in #32938.

zeke commented Apr 24, 2020

Copy link
Copy Markdown
Contributor Author

Okay. Happy to help with an update to https://github.com/nodejs/remark-preset-lint-node if that seems like the right course of action.

defer further work on this PR until @Trott has made some comments in #32938.

Looks like @Trott has already weighed in there. Were you expecting further comment?

DerekNonGeneric commented Apr 24, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor

Were you expecting further comment?

Absolutely. If not in that particular issue, in this PR (or elsewhere). I would give it some time.

DerekNonGeneric reviewed May 25, 2020
View reviewed changes

DerekNonGeneric left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I've put a bit more thought into exactly what info strings are available and what they all mean. I will followup this review comment w/ a PR augmenting the documentation guide clarifying my suggestions. Hopefully, it will be persuasive enough to take these suggestions. :)

Comment thread doc/api/tracing.md Outdated
Comment thread doc/guides/building-node-with-ninja.md Outdated
Comment thread doc/api/util.md Outdated
Comment thread doc/api/util.md Outdated
Comment thread doc/api/tracing.md Outdated
Comment thread doc/api/tracing.md Outdated
Comment thread doc/api/modules.md Outdated
Comment thread doc/api/errors.md Outdated
Comment thread doc/api/http.md Outdated
Comment thread doc/api/http2.md Outdated
zeke and others added 10 commits May 26, 2020 16:23
Update doc/guides/building-node-with-ninja.md
300c21c 
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
Update doc/api/util.md
4077339 
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
Update doc/api/errors.md
c7c91ad 
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
Update doc/api/http2.md
568bbf9 
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
Update doc/api/http.md
995e428 
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
Update doc/api/modules.md
2ace334 
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
Update doc/api/util.md
ed4162c 
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
Update doc/api/tracing.md
27c59e9 
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
Update doc/api/tracing.md
292c841 
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
Update doc/api/tracing.md
9e2c40c 
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
Update doc/api/tracing.md
317cf70 
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
BridgeAR added the author ready PRs that have at least one approval, no outstanding review comments, and a CI started. label May 27, 2020
BridgeAR pushed a commit to BridgeAR/node that referenced this pull request May 30, 2020
doc: update txt fandamental and ```raw code blocks
f08174c 
These are changed to either ```text or ```console.

PR-URL: nodejs#33028
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

BridgeAR commented May 30, 2020

Copy link
Copy Markdown
Member

Landed in f08174c

BridgeAR closed this May 30, 2020

DerekNonGeneric commented Jun 7, 2020

Copy link
Copy Markdown
Contributor

/re #33028 (comment) and #33028 (comment)

After updating the bundle to include the HTTP grammar, I noticed that although this is an HTTP request [almost] following HTTP semantics, it also includes linebreak escape characters.

This results in the sub-par highlighting as seen below. :(

I wonder if this is a deficiency in the highlighter's regex or this should have actually been text.

  • Should I forgo my intention of highlighting http info strings?
  • Will the new QUIC implementation include http info strings in its docs?

/cc @jasnell

Trott commented Jun 7, 2020

Copy link
Copy Markdown
Member
  • Should I forgo my intention of highlighting http info strings?

In the particular case from your screenshot, I think removing \r\n is appropriate. (As a general rule, I would think you can either show \n explicitly and not render the line break, or else there is no need to show \n. Since there are rendered line breaks here, the \r\n is not necessary to show.)

codebytere pushed a commit that referenced this pull request Jun 18, 2020
doc: update txt fandamental and ```raw code blocks
8e3a0d7 
These are changed to either ```text or ```console.

PR-URL: #33028
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Trott pushed a commit that referenced this pull request Jun 25, 2020
doc: add allowed info strings to style guide
e405e82 
This commit adds the list of agreed-upon info strings to the
documentation style guide to aid with future development and
maintenance.

Refs: #33510
Refs: #33507
Refs: #33483
Refs: #33531
Refs: #33542
Refs: #33028
Refs: #33548
Refs: #33486

PR-URL: #34024
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
codebytere pushed a commit that referenced this pull request Jun 27, 2020
doc: add allowed info strings to style guide
4323346 
This commit adds the list of agreed-upon info strings to the
documentation style guide to aid with future development and
maintenance.

Refs: #33510
Refs: #33507
Refs: #33483
Refs: #33531
Refs: #33542
Refs: #33028
Refs: #33548
Refs: #33486

PR-URL: #34024
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
codebytere mentioned this pull request Jun 28, 2020
Merged
codebytere pushed a commit that referenced this pull request Jun 30, 2020
doc: update txt fandamental and ```raw code blocks
3a53c2f 
These are changed to either ```text or ```console.

PR-URL: #33028
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
codebytere pushed a commit that referenced this pull request Jun 30, 2020
doc: add allowed info strings to style guide
b641a13 
This commit adds the list of agreed-upon info strings to the
documentation style guide to aid with future development and
maintenance.

Refs: #33510
Refs: #33507
Refs: #33483
Refs: #33531
Refs: #33542
Refs: #33028
Refs: #33548
Refs: #33486

PR-URL: #34024
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
codebytere pushed a commit that referenced this pull request Jul 8, 2020
doc: update txt fandamental and ```raw code blocks
7dc28ab 
These are changed to either ```text or ```console.

PR-URL: #33028
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
codebytere pushed a commit that referenced this pull request Jul 10, 2020
doc: add allowed info strings to style guide
5a9b809 
This commit adds the list of agreed-upon info strings to the
documentation style guide to aid with future development and
maintenance.

Refs: #33510
Refs: #33507
Refs: #33483
Refs: #33531
Refs: #33542
Refs: #33028
Refs: #33548
Refs: #33486

PR-URL: #34024
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
codebytere pushed a commit that referenced this pull request Jul 12, 2020
doc: add allowed info strings to style guide
04ceeaf 
This commit adds the list of agreed-upon info strings to the
documentation style guide to aid with future development and
maintenance.

Refs: #33510
Refs: #33507
Refs: #33483
Refs: #33531
Refs: #33542
Refs: #33028
Refs: #33548
Refs: #33486

PR-URL: #34024
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
codebytere mentioned this pull request Jul 13, 2020
Merged
codebytere pushed a commit that referenced this pull request Jul 14, 2020
doc: add allowed info strings to style guide
d9bfac6 
This commit adds the list of agreed-upon info strings to the
documentation style guide to aid with future development and
maintenance.

Refs: #33510
Refs: #33507
Refs: #33483
Refs: #33531
Refs: #33542
Refs: #33028
Refs: #33548
Refs: #33486

PR-URL: #34024
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

jasnell jasnell approved these changes
BridgeAR BridgeAR approved these changes
+1 more reviewer
DerekNonGeneric DerekNonGeneric approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no outstanding review comments, and a CI started. doc Issues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Inconsistent use of plaintext code fencing in docs

6 participants

Back | FazBrowse Home | New Git URL