Skip to content

Document comment styles and how to document APIs - #2336

Merged
Travis Prescott (tjprescott) merged 2 commits into
microsoft:mainfrom
tjprescott:documentDocs
Aug 28, 2023
Merged

Travis Prescott (tjprescott) merged 2 commits into
microsoft:mainfrom
tjprescott:documentDocs

Conversation

@tjprescott

Copy link
Copy Markdown
Member

Fixes #2312.

@github-actions

Copy link
Copy Markdown
Contributor

Changes in this PR will be published to the following url to try(check status of TypeSpec Pull Request Try It pipeline for publish status):
Playground: https://cadlplayground.z22.web.core.windows.net/prs/2336/

Website: https://cadlwebsite.z1.web.core.windows.net/prs/2336/

@markcowl Mark Cowlishaw (markcowl) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Two minor nits, otherwise, this looks great

Comment thread docs/language-basics/documentation.md Outdated
Comment thread docs/language-basics/documentation.md Outdated
@tjprescott
Travis Prescott (tjprescott) merged commit 2417239 into microsoft:main Aug 28, 2023
@tjprescott
Travis Prescott (tjprescott) deleted the documentDocs branch August 29, 2023 01:33
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.

Add documentation of "Doc comments" (and non-doc comments)

2 participants