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

Use example tag #13745

Merged
merged 2 commits into from
Feb 8, 2019
Merged

Use example tag #13745

merged 2 commits into from
Feb 8, 2019

Conversation

oandregal
Copy link
Member

We're about to create external documentation from the JSDoc comments. Using the @example tag makes the example to look nicer in the docs.

@oandregal oandregal self-assigned this Feb 7, 2019
@oandregal oandregal added the [Type] Developer Documentation Documentation for developers label Feb 7, 2019
@oandregal oandregal added this to the Documentation & Handbook milestone Feb 7, 2019
@oandregal oandregal added the Good First Review A PR that's suitable for someone looking to contribute for the first time by reviewing code label Feb 7, 2019
gziolo
gziolo approved these changes Feb 8, 2019
View reviewed changes
Copy link
Member

@gziolo gziolo left a comment

Choose a reason for hiding this comment

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

Looks good, do you plan to use e2e-test-utils as the first package to auto-generate docs? :)

@oandregal oandregal merged commit 6ba4775 into master Feb 8, 2019
@oandregal oandregal deleted the update/jsdoc-e2e-test-utils branch February 8, 2019 12:29
@oandregal
Copy link
Member Author

@gziolo sure!

This was referenced Feb 18, 2019
Merged
Merged
youknowriad pushed a commit that referenced this pull request Mar 6, 2019
@nosolosw @youknowriad
Use example tag in JSDoc (#13745)
ffdf9d5
youknowriad pushed a commit that referenced this pull request Mar 6, 2019
@nosolosw @youknowriad
Use example tag in JSDoc (#13745)
978e8f7
This was referenced Apr 30, 2020
Closed
Closed
Merged
Merged
Merged
Closed
Closed
Closed
Closed
This was referenced May 1, 2020
Merged
Closed
Merged
Closed
Merged
Closed
Closed
Closed
This was referenced Jul 16, 2024
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aduth aduth aduth left review comments

@gziolo gziolo gziolo approved these changes

@ajitbohra ajitbohra Awaiting requested review from ajitbohra

@nerrad nerrad Awaiting requested review from nerrad

@ntwb ntwb Awaiting requested review from ntwb

@youknowriad youknowriad Awaiting requested review from youknowriad

Assignees

@oandregal oandregal

Labels
Good First Review A PR that's suitable for someone looking to contribute for the first time by reviewing code [Type] Developer Documentation Documentation for developers
Projects
None yet
Milestone
Documentation & Handbook
Development

Successfully merging this pull request may close these issues.
3 participants
@oandregal @gziolo @aduth