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

Example syntax in comments #6

Closed
tazjin opened this issue Oct 26, 2018 · 1 comment
Closed

Example syntax in comments #6

tazjin opened this issue Oct 26, 2018 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@tazjin
Copy link
Contributor

tazjin commented Oct 26, 2018

In @grahamc's manually written doc comments, multiple (named) examples are supported. It would be great to be able to specify examples in the comments, too.

Currently these syntaxes are recognised:

Example: <some example code>

# or alternatively
Example:
    <some example code>

I propose keeping those working, and adding an additional syntax for named examples:

Example: This shows how to do X
    <code to do X>
@infinisil
Copy link
Collaborator

This won't be necessary anymore, since RFC 145 has been implemented, so one can just write free-form markdown as desired.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants