Skip to content

docs: render multiple @example blocks as tabbed code groups#3817

Merged
xDivisionByZerox merged 9 commits intonextfrom
docs-api-example-tabs
Apr 19, 2026
Merged

docs: render multiple @example blocks as tabbed code groups#3817
xDivisionByZerox merged 9 commits intonextfrom
docs-api-example-tabs

Conversation

@Shinigami92
Copy link
Copy Markdown
Member

@Shinigami92 Shinigami92 commented Apr 18, 2026

@Shinigami92 Shinigami92 added this to the vAnytime milestone Apr 18, 2026
@Shinigami92 Shinigami92 self-assigned this Apr 18, 2026
@Shinigami92 Shinigami92 requested a review from a team as a code owner April 18, 2026 19:14
@Shinigami92 Shinigami92 added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Apr 18, 2026
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 18, 2026

Deploy Preview for fakerjs ready!

Name Link
🔨 Latest commit 72a37a4
🔍 Latest deploy log https://app.netlify.com/projects/fakerjs/deploys/69e4172ea51c7f0008e57d8b
😎 Deploy Preview https://deploy-preview-3817.fakerjs.dev
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@Shinigami92 Shinigami92 requested a review from ST-DDT April 18, 2026 19:14
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 18, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.83%. Comparing base (04f21d3) to head (72a37a4).
⚠️ Report is 1 commits behind head on next.

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #3817      +/-   ##
==========================================
- Coverage   98.90%   98.83%   -0.07%     
==========================================
  Files         896      896              
  Lines        3100     3100              
  Branches      572      572              
==========================================
- Hits         3066     3064       -2     
- Misses         30       32       +2     
  Partials        4        4              
Files with missing lines Coverage Δ
src/faker.ts 100.00% <ø> (ø)

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown
Member

@ST-DDT ST-DDT left a comment

Choose a reason for hiding this comment

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

Could you please add multi example test cases to our tests?

I hope that these will get picked up automatically, if you just add them to the file.

Comment thread scripts/shared/markdown.ts Outdated
@Shinigami92 Shinigami92 marked this pull request as draft April 18, 2026 22:21
Comment thread test/scripts/shared/markdown.spec.ts Outdated
Comment thread test/scripts/shared/markdown.spec.ts Outdated
@Shinigami92 Shinigami92 requested a review from ST-DDT April 18, 2026 22:50
@Shinigami92 Shinigami92 force-pushed the docs-api-example-tabs branch from 3eea927 to abdf90b Compare April 18, 2026 22:50
Comment thread scripts/shared/markdown.ts Outdated
Comment thread scripts/shared/markdown.ts Outdated
Comment thread scripts/shared/markdown.ts Outdated
Comment thread scripts/shared/markdown.ts Outdated
Comment thread scripts/shared/markdown.ts Outdated
@Shinigami92 Shinigami92 marked this pull request as ready for review April 18, 2026 23:00
Comment thread scripts/apidocs/output/page.ts
@Shinigami92 Shinigami92 marked this pull request as draft April 18, 2026 23:04
@Shinigami92 Shinigami92 requested a review from ST-DDT April 18, 2026 23:13
@Shinigami92 Shinigami92 marked this pull request as ready for review April 18, 2026 23:30
Comment thread docs/.vitepress/components/api-docs/refreshable-code.vue Outdated
@Shinigami92 Shinigami92 force-pushed the docs-api-example-tabs branch from 149fccc to 72a37a4 Compare April 18, 2026 23:43
@xDivisionByZerox xDivisionByZerox self-requested a review April 19, 2026 12:29
Copy link
Copy Markdown
Member

@xDivisionByZerox xDivisionByZerox left a comment

Choose a reason for hiding this comment

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

Look cool. Thanks for that. 👍

@matthewmayer
Copy link
Copy Markdown
Contributor

We should follow up to see if there are any other example blocks which could benefit from being split like this.

Merged via the queue into next with commit cac6278 Apr 19, 2026
23 checks passed
@xDivisionByZerox xDivisionByZerox deleted the docs-api-example-tabs branch April 19, 2026 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

c: docs Improvements or additions to documentation p: 1-normal Nothing urgent

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants