Skip to content

Document cfg(trybuild) for test cases #347

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

Open
tridev-tej wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document cfg(trybuild) for test cases #347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,13 @@ Pass tests are considered to succeed if they compile successfully and have a

That's the entire API.

### Conditional compilation

Trybuild sets `cfg(trybuild)` when compiling test cases. In a test case,
use `#[cfg(trybuild)]` to include code in these compilations, or
`#[cfg(not(trybuild))]` to exclude it. Trybuild does not set this cfg for
the outer test harness that calls `TestCases`.

<br>

## Workflow
Expand Down
7 changes: 7 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,13 @@
//!
//! That's the entire API.
//!
//! ## Conditional compilation
//!
//! Trybuild sets `cfg(trybuild)` when compiling test cases. In a test case,
//! use `#[cfg(trybuild)]` to include code in these compilations, or
//! `#[cfg(not(trybuild))]` to exclude it. Trybuild does not set this cfg for
//! the outer test harness that calls `TestCases`.
//!
//! <br>
//!
//! # Workflow
Expand Down
Loading