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

doc: harmonize fenced code snippet flags #48082

Merged
merged 1 commit into from May 21, 2023
Merged

Conversation

aduh95
Copy link
Contributor

@aduh95 aduh95 commented May 19, 2023

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

@nodejs-github-bot
Copy link
Collaborator

Review requested:

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

@nodejs-github-bot nodejs-github-bot added build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. needs-ci PRs that need a full CI run. labels May 19, 2023
@alexsch01
Copy link
Contributor

LGTM

@richardlau
Copy link
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 aduh95 changed the title doc: remove single-line console code snippets doc: harmonize fenced code snippet flags May 20, 2023
Copy link
Contributor

@ShogunPanda ShogunPanda left a comment

Choose a reason for hiding this comment

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

LGTM!

@aduh95 aduh95 added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. and removed build Issues and PRs related to build files or the CI. needs-ci PRs that need a full CI run. labels May 20, 2023
@lpinca lpinca added commit-queue Add this label to land a pull request using GitHub Actions. fast-track PRs that do not need to wait for 48 hours to land. labels May 21, 2023
@github-actions
Copy link
Contributor

Fast-track has been requested by @lpinca. Please 👍 to approve.

@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels May 21, 2023
@nodejs-github-bot
Copy link
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

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 <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@aduh95
Copy link
Contributor Author

aduh95 commented May 21, 2023

Landed in 260092e

@aduh95 aduh95 merged commit 260092e into nodejs:main May 21, 2023
14 checks passed
@aduh95 aduh95 deleted the single-console branch May 21, 2023 07:39
fasenderos pushed a commit to fasenderos/node that referenced this pull request May 22, 2023
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 <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
fasenderos pushed a commit to fasenderos/node that referenced this pull request May 22, 2023
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 <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
targos pushed a commit that referenced this pull request May 30, 2023
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 <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@targos targos mentioned this pull request Jun 4, 2023
@danielleadams danielleadams added the backport-blocked-v18.x PRs that should land on the v18.x-staging branch but are blocked by another PR's pending backport. label Jul 3, 2023
@danielleadams
Copy link
Member

blocked by #47125

Ceres6 pushed a commit to Ceres6/node that referenced this pull request Aug 14, 2023
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 <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Ceres6 pushed a commit to Ceres6/node that referenced this pull request Aug 14, 2023
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 <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Luigi Pinca <luigipinca@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. backport-blocked-v18.x PRs that should land on the v18.x-staging branch but are blocked by another PR's pending backport. commit-queue-failed An error occurred while landing this pull request using GitHub Actions. doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 48 hours to land.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants