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

readme: 'cargo llvm-cov' does not run doc-tests #244

Closed
santhosh-tekuri opened this issue Mar 2, 2023 · 3 comments
Closed

readme: 'cargo llvm-cov' does not run doc-tests #244

santhosh-tekuri opened this issue Mar 2, 2023 · 3 comments
Labels
C-documentation Category: related to documentation. C-question Category: A question

Comments

@santhosh-tekuri
Copy link

readme suggests to use cargo llvm-cov instead of cargo test

but there is one difference cargo llvm-cov does not run doc-tests.
I think this should be mentioned explicitly in readme.

BTW, I replaced cargo test with cargo llvm-cov in my CI, and wondering why it is not showing any errors in doc tests.

@taiki-e
Copy link
Owner

taiki-e commented Mar 2, 2023

readme says:

Support for doc tests. (this is currently optional and requires nightly, see #2 for more)

@taiki-e taiki-e added the C-question Category: A question label Mar 2, 2023
@santhosh-tekuri
Copy link
Author

santhosh-tekuri commented Mar 2, 2023

I saw it. But as a first time user, I jumped directly to Usage section. I guess most first time users do the same and don't realise this .

@taiki-e taiki-e closed this as completed in c5d3c43 Mar 2, 2023
@taiki-e
Copy link
Owner

taiki-e commented Mar 2, 2023

Ok, I added a description about doctests in the "Usage" section as well. Thanks for the feedback.

@taiki-e taiki-e added the C-documentation Category: related to documentation. label Mar 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-documentation Category: related to documentation. C-question Category: A question
Projects
None yet
Development

No branches or pull requests

2 participants