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

Make @example a known doc tag #1453

Open
timotheeguerin opened this issue Dec 15, 2022 · 1 comment
Open

Make @example a known doc tag #1453

timotheeguerin opened this issue Dec 15, 2022 · 1 comment
Milestone

Comments

@timotheeguerin
Copy link
Member

timotheeguerin commented Dec 15, 2022

Proposal

Add @example as a known tag with the following format

First line is the title (optional - if line is empty then there is no title)
Rest is the tag content

/**
 *  @example First line is example title
 * rest is 
 * example
 * content
 *
 */

woudl result in the following

{
  title: "First line is example title",
  content: "rest is\nexample\ncontent",
}
@ghost ghost added the Needs Triage label Dec 15, 2022
@markcowl markcowl added this to the [2023] April milestone Jan 3, 2023
@markcowl
Copy link
Contributor

markcowl commented Jan 3, 2023

est: 5

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

No branches or pull requests

3 participants