-
-
Notifications
You must be signed in to change notification settings - Fork 585
Fix multi-line jsdoc comments #2480
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
base: main
Are you sure you want to change the base?
Conversation
|
✅ Deploy Preview for openapi-ts canceled.
|
much needed |
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.
Thanks for the fix! If you could add a patch
changeset please (see the comment), we can release this
* | ||
* 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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!
Changes
openapi-typescript
currently 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:examples
run (only applicable for openapi-typescript)