GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — doc: harmonize fenced code snippet flags by aduh95 · Pull Request #48082 · nodejs/node

Conversation

@aduh95

@aduh95 aduh95 commented May 19, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

We had a few code snippets that were using a non-descriptive tag (e.g. console or text), whereas the actual language it's using describes it better, and improves the syntax highlighting. This PR also removes non-necessary leading chars (e.g. $, >, or %) to make it easier for readers to copy and paste to try the command themselves.

/cc @alexsch01

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
Frank122480 reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@nodejs-github-bot

nodejs-github-bot commented May 19, 2023

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/net
  • @nodejs/single-executable
  • @nodejs/tsc
  • @nodejs/wasi
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@nodejs-github-bot nodejs-github-bot added build Issues and PRs related to Node.js builds or CI infrastructure. doc Issues and PRs related to Node.js documentation. needs-ci PRs that need a full CI run. labels May 19, 2023
@alexsch01

alexsch01 commented May 19, 2023

Copy link
Copy Markdown
Contributor

LGTM
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
Trott
Trott approved these changes May 19, 2023
View reviewed changes
@richardlau

richardlau commented May 19, 2023

Copy link
Copy Markdown
Member

There are still a few one liners in BUILDING.md, e.g.

node/BUILDING.md

Lines 324 to 326 in da31b4d

```text
$ tools/test.py test/parallel/test-stream2-transform.js
```

aduh95 reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
RaisinTen
RaisinTen approved these changes May 20, 2023
View reviewed changes
@aduh95 aduh95 changed the title doc: remove single-line console code snippets doc: harmonize fenced code snippet flags May 20, 2023
ShogunPanda
ShogunPanda approved these changes May 20, 2023
View reviewed changes

@ShogunPanda ShogunPanda left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

LGTM!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@aduh95 aduh95 added author ready PRs with CI started, the required approvals, and no outstanding review comments. and removed build Issues and PRs related to Node.js builds or CI infrastructure. needs-ci PRs that need a full CI run. labels May 20, 2023
lpinca
lpinca approved these changes May 21, 2023
View reviewed changes
@lpinca lpinca added commit-queue PRs queued for automated landing through the Commit Queue. fast-track PRs proposed for a shorter-than-standard waiting period before landing. labels May 21, 2023
@github-actions

github-actions Bot commented May 21, 2023

Copy link
Copy Markdown
Contributor

Fast-track has been requested by @lpinca. Please 👍 to approve.
lpinca and RaisinTen reacted with thumbs up emoji
All reactions
  • 👍 2 reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@nodejs-github-bot nodejs-github-bot added commit-queue-failed PRs whose Commit Queue landing failed and need manual intervention before retrying. and removed commit-queue PRs queued for automated landing through the Commit Queue. labels May 21, 2023
@nodejs-github-bot

nodejs-github-bot commented May 21, 2023

Copy link
Copy Markdown
Collaborator
Commit Queue failed
- Loading data for nodejs/node/pull/48082
✔  Done loading data for nodejs/node/pull/48082
----------------------------------- PR info ------------------------------------
Title      doc: harmonize fenced code snippet flags (#48082)
   ⚠  Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch     aduh95:single-console -> nodejs:main
Labels     doc, fast-track, author ready
Commits    3
 - doc: remove single-line console code snippets
 - fix remaining snippets
 - fixup! fix remaining snippets
Committers 1
 - Antoine du Hamel 
PR-URL: https://github.com/nodejs/node/pull/48082
Reviewed-By: Rich Trott 
Reviewed-By: Darshan Sen 
Reviewed-By: Paolo Insogna 
Reviewed-By: Luigi Pinca 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/48082
Reviewed-By: Rich Trott 
Reviewed-By: Darshan Sen 
Reviewed-By: Paolo Insogna 
Reviewed-By: Luigi Pinca 
--------------------------------------------------------------------------------
   ℹ  This PR was created on Fri, 19 May 2023 22:18:29 GMT
   ✔  Approvals: 4
   ✔  - Rich Trott (@Trott) (TSC): https://github.com/nodejs/node/pull/48082#pullrequestreview-1435267728
   ✔  - Darshan Sen (@RaisinTen) (TSC): https://github.com/nodejs/node/pull/48082#pullrequestreview-1435362293
   ✔  - Paolo Insogna (@ShogunPanda): https://github.com/nodejs/node/pull/48082#pullrequestreview-1435416759
   ✔  - Luigi Pinca (@lpinca): https://github.com/nodejs/node/pull/48082#pullrequestreview-1435475223
   ℹ  This PR is being fast-tracked
   ✘  This PR needs to wait 16 more hours to land (or 0 hours if there is 1 more approval (👍) of the fast-track request from collaborators).
   ✔  Last GitHub CI successful
   ℹ  Green GitHub CI is sufficient
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu
https://github.com/nodejs/node/actions/runs/5036077796
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@aduh95
doc: harmonize fenced code snippet flags
260092e 
We had a few code snippets that were using a non-descriptive tag (e.g.
`console` or `text`), whereas the actual language it's using describes
it better, and improves the syntax highlighting. This commit also
removes non-necessary leading chars (e.g. `$`, `>`, or `%`) to make it
easier for readers to copy and paste to try the command themselves.

PR-URL: nodejs#48082
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Paolo Insogna <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
@aduh95
aduh95 force-pushed the single-console branch from ef518d5 to 260092e Compare May 21, 2023 07:37
@aduh95

aduh95 commented May 21, 2023

Copy link
Copy Markdown
Contributor Author

Landed in 260092e
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@aduh95
aduh95 merged commit 260092e into nodejs:main May 21, 2023
@aduh95
aduh95 deleted the single-console branch May 21, 2023 07:39
@aduh95 aduh95 mentioned this pull request May 21, 2023
doc: fix Windows code snippet tags #48100
Merged
targos pushed a commit that referenced this pull request May 30, 2023
@aduh95 @targos
doc: harmonize fenced code snippet flags
12fef9b 
We had a few code snippets that were using a non-descriptive tag (e.g.
`console` or `text`), whereas the actual language it's using describes
it better, and improves the syntax highlighting. This commit also
removes non-necessary leading chars (e.g. `$`, `>`, or `%`) to make it
easier for readers to copy and paste to try the command themselves.

PR-URL: #48082
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Paolo Insogna <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
@targos targos mentioned this pull request Jun 4, 2023
v20.3.0 release proposal #48332
Merged
@danielleadams danielleadams added the backport-blocked-v18.x label Jul 3, 2023
@danielleadams

danielleadams commented Jul 3, 2023

Copy link
Copy Markdown
Contributor

blocked by #47125
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
Ceres6 pushed a commit to Ceres6/node that referenced this pull request Aug 14, 2023
@aduh95 @Ceres6
doc: harmonize fenced code snippet flags
e9f8fc6 
We had a few code snippets that were using a non-descriptive tag (e.g.
`console` or `text`), whereas the actual language it's using describes
it better, and improves the syntax highlighting. This commit also
removes non-necessary leading chars (e.g. `$`, `>`, or `%`) to make it
easier for readers to copy and paste to try the command themselves.

PR-URL: nodejs#48082
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Paolo Insogna <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Ceres6 pushed a commit to Ceres6/node that referenced this pull request Aug 14, 2023
@aduh95 @Ceres6
doc: harmonize fenced code snippet flags
7348038 
We had a few code snippets that were using a non-descriptive tag (e.g.
`console` or `text`), whereas the actual language it's using describes
it better, and improves the syntax highlighting. This commit also
removes non-necessary leading chars (e.g. `$`, `>`, or `%`) to make it
easier for readers to copy and paste to try the command themselves.

PR-URL: nodejs#48082
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Paolo Insogna <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ShogunPanda ShogunPanda ShogunPanda approved these changes
@Trott Trott Trott approved these changes
@lpinca lpinca lpinca approved these changes
@RaisinTen RaisinTen RaisinTen approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

author ready PRs with CI started, the required approvals, and no outstanding review comments. commit-queue-failed PRs whose Commit Queue landing failed and need manual intervention before retrying. doc Issues and PRs related to Node.js documentation. fast-track PRs proposed for a shorter-than-standard waiting period before landing.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

9 participants

@aduh95 @nodejs-github-bot @alexsch01 @richardlau @danielleadams @ShogunPanda @Trott @lpinca @RaisinTen
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.