Skip to content

doc,test: fix docs/api copy #57109

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.

Sign up for GitHub

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

Closed
1ilsang wants to merge 2 commits into from
Closed

doc,test: fix docs/api copy #57109

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4171546
tools: consolidate 'introduced_in' check for docs
1ilsang Feb 20, 2025
dff2f62
doc: fix 'introduced_in' version in typescript module
1ilsang Feb 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
tools: consolidate 'introduced_in' check for docs
  • Loading branch information
@1ilsang
1ilsang committed Feb 20, 2025
commit 41715462bd65bea448c8c257ac1924f90b8f64d8
2 changes: 2 additions & 0 deletions doc/api/typescript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ changes:
description: Added `--experimental-transform-types` flag.
-->

<!--introduced_in=v23.6.0-->
Comment thread
jakecastelli marked this conversation as resolved.
Resolved

> Stability: 1.1 - Active development

## Enabling
Expand Down
8 changes: 8 additions & 0 deletions tools/lint-md/lint-md.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,14 @@ paths.forEach(async (path) => {
const fileContents = file.toString();
const result = await linter.process(file);
const isDifferent = fileContents !== result.toString();

if (path.startsWith('doc/api/')) {
if (!fileContents.includes('introduced_in')) {
console.error(`${path} is missing an 'introduced_in' version. Please add one.`);
process.exitCode = 1;
}
}

if (format) {
if (isDifferent) {
fs.writeFileSync(path, result.toString());
Expand Down