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

docs - add hint that doc-tests are supported #168

Open
noah04 opened this issue Jan 23, 2020 · 1 comment
Open

docs - add hint that doc-tests are supported #168

noah04 opened this issue Jan 23, 2020 · 1 comment

Comments

@noah04
Copy link

noah04 commented Jan 23, 2020

The documentations introductory section about the basic syntax says:

Attributes (including doc comments) are supported as well.

While reading it, I wondered if doc-tests are also supported. I tried it myself and it worked quite well. Is this an intended feature? If so, I'd like to create a PR to include that in the docs (maybe also with an example).

Cheers and thanks for your work!
@LukasKalbertodt
Copy link
Member

Yes, this is intended. Supporting doc comments kind of implies supporting doc tests. But I guess it doesn't hurt to mention it explicitly, so feel free to open a PR!

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
2 participants
@LukasKalbertodt @noah04