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

Support of @example tag #2

Open
ziflex opened this issue May 23, 2020 · 0 comments
Open

Support of @example tag #2

ziflex opened this issue May 23, 2020 · 0 comments

Comments

@ziflex
Copy link
Member

ziflex commented May 23, 2020

We might want to extend our API documentation with some examples of how to use a particular functionality.
Having @example tag would let us to provide this to both code and documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ziflex