-
Notifications
You must be signed in to change notification settings - Fork 461
docs(repo): stop multi-@example rendering from inserting duplicate commas #9204
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
Merged
+32
−1
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
e9797b0
fix(typedoc): stop multi-@example rendering from inserting a spurious…
SarahSoutoul 180647d
docs(repo): make typedoc comma fix changeset empty
SarahSoutoul f323fc9
docs(repo): condense multi-example replacement comment
manovotny cde9a65
Merge branch 'main' into fix/typedoc-multi-example-double-comma
SarahSoutoul d4576d1
ci: retrigger checks
SarahSoutoul File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| --- | ||
| --- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| import { describe, expect, it } from 'vitest'; | ||
|
|
||
| // @ts-expect-error — .mjs plugin has no type declarations | ||
| import { applyCatchAllMdReplacements } from '../custom-plugin.mjs'; | ||
|
|
||
| /** | ||
| * Unit coverage for the `getCatchAllReplacements()` rules exercised through the | ||
| * exported `applyCatchAllMdReplacements()` entry point. | ||
| */ | ||
| describe('applyCatchAllMdReplacements', () => { | ||
| it('renders a single `@example` as "Example: `value`."', () => { | ||
| expect(applyCatchAllMdReplacements('**Example** `foo`')).toBe('Example: `foo`.'); | ||
| }); | ||
|
|
||
| it('joins multiple `@example` blocks with ", "', () => { | ||
| expect(applyCatchAllMdReplacements('**Examples** `a` `b` `c`')).toBe('Examples: `a`, `b`, `c`.'); | ||
| }); | ||
|
|
||
| it('does not corrupt examples that contain internal spaces', () => { | ||
| // Regression: splitting the captured group on ' ' rejoined each example's | ||
| // internal spaces with ", ", producing a spurious `,,` inside array literals. | ||
| const input = '**Examples** `["/orgs/:slug", "/orgs/:slug/(.*)"]` `["/orgs/:id", "/orgs/:id/(.*)"]`'; | ||
| expect(applyCatchAllMdReplacements(input)).toBe( | ||
| 'Examples: `["/orgs/:slug", "/orgs/:slug/(.*)"]`, `["/orgs/:id", "/orgs/:id/(.*)"]`.', | ||
| ); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can do an empty changeset? Since this does not change the backend at all 👍🏼
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good pt! All done @wobsoriano