Skip to content

Conversation

@1ilsang
Copy link
Member

image

The Copy button doesn't work on page docs/api/typescript.

image

altDocs function is throwing an null properties error because introduced_in is missing.

Probably all API documentation should have <!--introduced_in=vVERSION-->, So Added a test in lint-md.mjs as well.

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/typescript

@nodejs-github-botnodejs-github-bot added the tools Issues and PRs related to the tools directory. label Feb 17, 2025
Copy link
Member

@jakecastellijakecastelli left a comment

Choose a reason for hiding this comment

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

looks good to me, except the module introduced _in version may need some confirmations

Copy link
Member

@jakecastellijakecastelli left a comment

Choose a reason for hiding this comment

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

LGTM

@jakecastellijakecastelli added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Feb 19, 2025
@jakecastellijakecastelli added commit-queue Add this label to land a pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Feb 20, 2025
@nodejs-github-botnodejs-github-bot added the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label Feb 20, 2025
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/57109 ✔ Done loading data for nodejs/node/pull/57109 ----------------------------------- PR info ------------------------------------ Title doc,test: fix docs/api copy (#57109) Author 1ilsang <[email protected]> (@1ilsang) Branch 1ilsang:test/md-lint -> nodejs:main Labels tools, author ready Commits 2 - doc,test: fix docs/api copy - doc: fix introduced version Committers 1 - 1ilsang <[email protected]> PR-URL: https://github.com/nodejs/node/pull/57109 Reviewed-By: Jake Yuesong Li <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/57109 Reviewed-By: Jake Yuesong Li <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> -------------------------------------------------------------------------------- ℹ This PR was created on Mon, 17 Feb 2025 17:11:43 GMT ✔ Approvals: 3 ✔ - Jake Yuesong Li (@jakecastelli): https://github.com/nodejs/node/pull/57109#pullrequestreview-2625579028 ✔ - Marco Ippolito (@marco-ippolito) (TSC): https://github.com/nodejs/node/pull/57109#pullrequestreview-2625750437 ✔ - Luigi Pinca (@lpinca): https://github.com/nodejs/node/pull/57109#pullrequestreview-2628003039 ✔ Last GitHub CI successful ℹ Green GitHub CI is sufficient -------------------------------------------------------------------------------- ✔ No git cherry-pick in progress ✔ No git am in progress ✔ No git rebase in progress -------------------------------------------------------------------------------- - Bringing origin/main up to date... From https://github.com/nodejs/node * branch main -> FETCH_HEAD ✔ origin/main is now up-to-date - Downloading patch for 57109 From https://github.com/nodejs/node * branch refs/pull/57109/merge -> FETCH_HEAD ✔ Fetched commits as f6ce48636b08..721e37db3758 -------------------------------------------------------------------------------- [main 6c319eff14] doc,test: fix docs/api copy Author: 1ilsang <[email protected]> Date: Tue Feb 18 01:59:41 2025 +0900 2 files changed, 10 insertions(+) [main d7497a1d90] doc: fix introduced version Author: 1ilsang <[email protected]> Date: Tue Feb 18 18:27:35 2025 +0900 1 file changed, 1 insertion(+), 1 deletion(-) ✔ Patches applied There are 2 commits in the PR. Attempting autorebase. Rebasing (2/4) Executing: git node land --amend --yes --------------------------------- New Message ---------------------------------- doc,test: fix docs/api copy 

PR-URL: #57109
Reviewed-By: Jake Yuesong Li <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>

[detached HEAD 4a39dbd484] doc,test: fix docs/api copy
Author: 1ilsang <[email protected]>
Date: Tue Feb 18 01:59:41 2025 +0900
2 files changed, 10 insertions(+)
Rebasing (3/4)
Rebasing (4/4)
Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
doc: fix introduced version

PR-URL: #57109
Reviewed-By: Jake Yuesong Li <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>

[detached HEAD 03c94ae515] doc: fix introduced version
Author: 1ilsang <[email protected]>
Date: Tue Feb 18 18:27:35 2025 +0900
1 file changed, 1 insertion(+), 1 deletion(-)
Successfully rebased and updated refs/heads/main.

ℹ Add commit-queue-squash label to land the PR as one commit, or commit-queue-rebase to land as separate commits.

https://github.com/nodejs/node/actions/runs/13427134365

@jakecastelli
Copy link
Member

A miner suggestion for the commit messages:

first commit - tools: consolidate introduced_in check for docs
second commit - doc: fix introduced_in version in typescript module

@jakecastellijakecastelli removed the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label Feb 20, 2025
@jakecastellijakecastelli added commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-rebase Add this label to allow the Commit Queue to land a PR in several commits. labels Feb 20, 2025
@nodejs-github-botnodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Feb 20, 2025
@nodejs-github-bot
Copy link
Collaborator

Landed in 15fec13...867a754

nodejs-github-bot pushed a commit that referenced this pull request Feb 20, 2025
PR-URL: #57109 Reviewed-By: Jake Yuesong Li <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
nodejs-github-bot pushed a commit that referenced this pull request Feb 20, 2025
PR-URL: #57109 Reviewed-By: Jake Yuesong Li <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
acidiney pushed a commit to acidiney/node that referenced this pull request Feb 23, 2025
PR-URL: nodejs#57109 Reviewed-By: Jake Yuesong Li <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
acidiney pushed a commit to acidiney/node that referenced this pull request Feb 23, 2025
PR-URL: nodejs#57109 Reviewed-By: Jake Yuesong Li <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
targos pushed a commit that referenced this pull request Feb 24, 2025
PR-URL: #57109 Reviewed-By: Jake Yuesong Li <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
targos pushed a commit that referenced this pull request Feb 24, 2025
PR-URL: #57109 Reviewed-By: Jake Yuesong Li <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
targos pushed a commit that referenced this pull request Feb 25, 2025
PR-URL: #57109 Reviewed-By: Jake Yuesong Li <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
targos pushed a commit that referenced this pull request Feb 25, 2025
PR-URL: #57109 Reviewed-By: Jake Yuesong Li <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
aduh95 pushed a commit that referenced this pull request Apr 2, 2025
PR-URL: #57109 Reviewed-By: Jake Yuesong Li <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
aduh95 pushed a commit that referenced this pull request Apr 2, 2025
PR-URL: #57109 Reviewed-By: Jake Yuesong Li <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
aduh95 pushed a commit that referenced this pull request Apr 3, 2025
PR-URL: #57109 Reviewed-By: Jake Yuesong Li <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
aduh95 pushed a commit that referenced this pull request Apr 3, 2025
PR-URL: #57109 Reviewed-By: Jake Yuesong Li <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
RafaelGSS pushed a commit that referenced this pull request Apr 16, 2025
PR-URL: #57109 Reviewed-By: Jake Yuesong Li <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
RafaelGSS pushed a commit that referenced this pull request Apr 16, 2025
PR-URL: #57109 Reviewed-By: Jake Yuesong Li <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
RafaelGSS pushed a commit that referenced this pull request Apr 17, 2025
PR-URL: #57109 Reviewed-By: Jake Yuesong Li <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
RafaelGSS pushed a commit that referenced this pull request Apr 17, 2025
PR-URL: #57109 Reviewed-By: Jake Yuesong Li <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
@marco-ippolitomarco-ippolito added the strip-types Issues or PRs related to strip-types support label Jun 5, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.commit-queue-rebaseAdd this label to allow the Commit Queue to land a PR in several commits.strip-typesIssues or PRs related to strip-types supporttoolsIssues and PRs related to the tools directory.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@1ilsang@nodejs-github-bot@jakecastelli@lpinca@marco-ippolito