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

test doc comments #226

Open
Orycterope opened this issue Mar 15, 2019 · 3 comments
Open

test doc comments #226

Orycterope opened this issue Mar 15, 2019 · 3 comments
Labels
infra Related to the infra/tooling. We're going meta.

Comments

@Orycterope
Copy link
Member

Our documentation code snippets are not compiled, nor tested.

According to an old rust book documentation is only checked for libraries, but not binaries.

We should fix this, as documentation is really important !

@roblabla roblabla added the infra Related to the infra/tooling. We're going meta. label Mar 18, 2019
@roblabla
Copy link
Member

There are actually two bugs here:

We should find a way to fix the second one. Ideally, our libs should work on 64-bit targets anyways, so maybe we should try fixing cargo test to work on x86_64-unknown-* along with the current 32-bit target?

@roblabla
Copy link
Member

Since #432 we now run the public components' doctests in libraries.

@roblabla
Copy link
Member

rust-lang/cargo#6892 got merged, when we next update rust we'll be able to remove the testinner rule.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infra Related to the infra/tooling. We're going meta.
Projects
None yet
Development

No branches or pull requests

2 participants