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.

Sign up for GitHub

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

Jump to bottom

Be explicit that @doc supports markdown content #1580

Closed
mikekistler opened this issue Jan 25, 2023 · 1 comment · Fixed by #6146
Closed

Be explicit that @doc supports markdown content #1580

mikekistler opened this issue Jan 25, 2023 · 1 comment · Fixed by #6146
Assignees
@timotheeguerin
Labels
1_0_E2E docs Improvements or additions to documentation feature New feature or request
Milestone
[2025] March

Comments

@mikekistler
Copy link
Member

Since descriptions in OpenAPI allow markdown, we should support markdown content in @doc comments that end up populating descriptions in generated OpenAPI.
@ghost ghost added the Needs Triage label Jan 25, 2023
@mikekistler mikekistler added docs Improvements or additions to documentation and removed Needs Triage labels Jan 25, 2023
@markcowl markcowl added this to the [2023] March milestone Jan 26, 2023
@markcowl
Copy link
Contributor

est: 1

@markcowl markcowl added the 📌 label Jan 27, 2023
@markcowl markcowl modified the milestones: [2023] May, Backlog Apr 5, 2023
@timotheeguerin timotheeguerin self-assigned this Feb 25, 2025
@timotheeguerin timotheeguerin mentioned this issue Feb 25, 2025
Merged
@timotheeguerin timotheeguerin modified the milestones: Backlog, [2025] March Feb 25, 2025
@markcowl markcowl added 1_0_E2E feature New feature or request labels Feb 25, 2025
github-merge-queue bot pushed a commit that referenced this issue Feb 27, 2025
@timotheeguerin
Add documentation specifying typespec docs support markdown (#6146)
5d3b746 
fix #1580
fix #171
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@timotheeguerin timotheeguerin

Labels
1_0_E2E docs Improvements or additions to documentation feature New feature or request
Projects
None yet
Milestone
[2025] March
Development

Successfully merging a pull request may close this issue.

Add documentation specifying typespec docs support markdown timotheeguerin/typespec
4 participants
@bterlson @timotheeguerin @markcowl @mikekistler