Fix multi-line jsdoc comments #2480
Open
+3,991
−2,211
Conversation
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
🦋 Changeset detectedLatest commit: af2d0b4 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
👷 Deploy request for openapi-ts pending review.Visit the deploys page to approve it
|
|
much needed |
drwpow
approved these changes
Oct 14, 2025
| * | ||
| * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). | ||
| * */ | ||
| */ |
There was a problem hiding this comment.
Nice! Normally big smoke tests like this are really only testing “did this blow up on a very large schema” but in cases like this you can see the improvement. Thank you!
|
Done @drwpow ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Changes
openapi-typescriptcurrently generates invalid jsdoc multi-line comments. The following PR patches this issue.How to Review
Take a look at the new jsdoc comments. The content of these should be exactly the same, but formatting for multi-line will be slightly better.
Checklist
docs/updated (if necessary)pnpm run update:examplesrun (only applicable for openapi-typescript)