Skip to content

Use example tag - #13745

Merged
oandregal merged 2 commits into
masterfrom
update/jsdoc-e2e-test-utils
Feb 8, 2019
Merged

oandregal merged 2 commits into
masterfrom
update/jsdoc-e2e-test-utils

Conversation

@oandregal

Copy link
Copy Markdown
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 left a comment

Copy link
Copy Markdown
Member

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
Copy Markdown
Member Author

@gziolo sure!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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

Development

Successfully merging this pull request may close these issues.

3 participants