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

Preserve leading whitespace in fenced blocks in doc comments #3399

Merged

Conversation

Veetaha
Copy link
Contributor

@Veetaha Veetaha commented May 18, 2024

Fixes #3370.

This also updates the generated documentation and typescript code to fix lack of indentation on existing fenced blocks in this repo.

@azure-sdk
Copy link
Collaborator

azure-sdk commented May 20, 2024

❌ There is undocummented changes. Run chronus add to add a changeset or click here.

The following packages have changes but are not documented.

  • @typespec/compiler

The following packages have already been documented:

  • @typespec/http
  • @typespec/protobuf
  • @typespec/rest
  • @typespec/versioning
  • @typespec/xml
Show changes

@typespec/http - internal ✏️

Regen docs

@typespec/protobuf - internal ✏️

Regen docs

@typespec/rest - internal ✏️

Regen docs

@typespec/versioning - internal ✏️

Regen docs

@typespec/xml - internal ✏️

Regen docs

@timotheeguerin
Copy link
Member

/azp run typespec - pr tools

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@microsoft microsoft deleted a comment from azure-pipelines bot May 20, 2024
@timotheeguerin timotheeguerin added the compiler:core Issues for @typespec/compiler label May 20, 2024
@azure-sdk
Copy link
Collaborator

You can try these changes at https://cadlplayground.z22.web.core.windows.net/prs/3399/

Check the website changes at https://tspwebsitepr.z22.web.core.windows.net/prs/3399/

Copy link
Member

@timotheeguerin timotheeguerin left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution! this looks good, talked with the Team.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
compiler:core Issues for @typespec/compiler
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: JSON Schema emitter drops indentation of fenced code blocks inside of doc comments (/** */)
3 participants