Skip to content
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

update tsp-openapi3 automatic doc newlines logic #3839

Merged
merged 2 commits into from
Jul 15, 2024

Conversation

chrisradek
Copy link
Member

Fixes #3835

tsp-openapi3 will no longer automatically attempt to wrap documentation strings based on maximum column width.

It will still honor any line breaks that exist in the original documentation when generating doc strings.

@azure-sdk
Copy link
Collaborator

All changed packages have been documented.

  • @typespec/openapi3
Show changes

@typespec/openapi3 - fix ✏️

Updates tsp-openapi3 doc line wrapping to only automatically create newlines when they are present in the original documentation.

@azure-sdk
Copy link
Collaborator

You can try these changes here

🛝 Playground 🌐 Website 📚 Next docs

@chrisradek chrisradek added this pull request to the merge queue Jul 15, 2024
Merged via the queue into microsoft:main with commit 65a0288 Jul 15, 2024
22 checks passed
@chrisradek chrisradek deleted the tsp-openapi3-fix-doc-newlines branch July 15, 2024 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: tsp-openapi3: automatic doc newlines break code spans
3 participants