Skip to content

doc: document major finished changes in v14 - #33065

Closed
ronag wants to merge 5 commits into
nodejs:masterfrom
nxtedition:finished-changes-history
Closed

doc: document major finished changes in v14#33065
ronag wants to merge 5 commits into
nodejs:masterfrom
nxtedition:finished-changes-history

Conversation

@ronag

Copy link
Copy Markdown
Member

Added description of semver-major changes to finished in v14.

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

@ronagronag added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels Apr 25, 2020
@ronag
ronag requested a review from mcollinaApril 25, 2020 19:18
@ronag
ronagforce-pushed the finished-changes-history branch 6 times, most recently from ba4897e to 329583bCompareApril 25, 2020 19:25
Added description of semver-major changes to finished in v14.
@ronag
ronagforce-pushed the finished-changes-history branch from 329583b to 9392877CompareApril 25, 2020 19:26
@ronag

ronag commented Apr 25, 2020

Copy link
Copy Markdown
MemberAuthor

@nodejs/documentation make lint-md succeeds, but build-docs fails. I might need a little help figuring out the proper formatting.

https://github.com/nodejs/node/pull/33065/checks?check_run_id=618533325

@mcollinamcollina left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lgtm

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@ronag

ronag commented Apr 26, 2020

Copy link
Copy Markdown
MemberAuthor

Stuck at formatting issue.

@addaleax

Copy link
Copy Markdown
Member

@ronag You probably want to indent the description: blocks, e.g. like this:

description: Changed "strict mode" to "strict assertion mode" and "legacy
mode" to "legacy assertion mode" to avoid confusion with the
more usual meaining of "strict mode".

Otherwise the YAML parser doesn’t know that the subsequent lines still belong to the description: value.

@addaleaxaddaleax left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM with the linter/doc build passing

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@ronag

Copy link
Copy Markdown
MemberAuthor

Still formatting issues 😕

@addaleax

Copy link
Copy Markdown
Member

@ronag Ah yeah, YAML is not a fan of strings starting with backticks … you can make the first line description: > and then put the rest of the text in subsequent lines, I think

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Comment threaddoc/api/stream.md
@ronag

Copy link
Copy Markdown
MemberAuthor

Landed in e5512ac

@ronagronag closed this Apr 27, 2020
ronag added a commit that referenced this pull request Apr 27, 2020
Added description of semver-major changes to finished in v14.
PR-URL: #33065
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
BethGriggs pushed a commit that referenced this pull request Apr 28, 2020
Added description of semver-major changes to finished in v14.
PR-URL: #33065
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
BridgeAR pushed a commit that referenced this pull request Apr 28, 2020
Added description of semver-major changes to finished in v14.
PR-URL: #33065
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
BridgeAR pushed a commit that referenced this pull request Apr 28, 2020
Added description of semver-major changes to finished in v14.
PR-URL: #33065
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
@BridgeARBridgeAR mentioned this pull request Apr 28, 2020
@BethGriggsBethGriggs mentioned this pull request Apr 28, 2020
BethGriggs pushed a commit that referenced this pull request Apr 28, 2020
Added description of semver-major changes to finished in v14.
PR-URL: #33065
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.streamIssues and PRs related to the stream subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants

@ronag@nodejs-github-bot@addaleax@mcollina@jasnell@lpinca@aduh95@trivikr@juanarbol@targos