Skip to content

Commit

Permalink
Reorder 'Features' section in README
Browse files Browse the repository at this point in the history
Order the 'Features' section before 'Logging Configuration' in the
README. It arguably make more sense to first discuss available feature
to raise awareness for the two supported backends.
  • Loading branch information
d-e-s-o committed Apr 30, 2024
1 parent 4a50628 commit 07be0a2
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,21 @@ async fn it_still_works() {
}
```

#### Features

The crate comes with two features pertaining "backend" initialization:
- `log`, enabled by default, controls initialization for the `log`
crate.
- `trace`, disabled by default, controls initialization for the
`tracing` crate.

Depending on what backend the crate-under-test (and its dependencies)
use, the respective feature(s) should be enabled to make messages that
are emitted by the test manifest on the terminal.

On top of that, the `color` feature (enabled by default) controls
whether to color output by default.

#### Logging Configuration

As usual when running `cargo test`, the output is captured by the
Expand All @@ -101,21 +116,6 @@ Valid events are `new`, `enter`, `exit`, `close`, `active`, and `full`.
See the [`tracing_subscriber` docs][tracing-events-docs-rs] for details
on what the events mean.

#### Features

The crate comes with two features pertaining "backend" initialization:
- `log`, enabled by default, controls initialization for the `log`
crate.
- `trace`, disabled by default, controls initialization for the
`tracing` crate.

Depending on what backend the crate-under-test (and its dependencies)
use, the respective feature should be enabled to make messages that are
emitted by the test manifest on the terminal.

On top of that, the `color` feature (enabled by default) controls
whether to color output by default.

#### MSRV Policy
This crate adheres to Cargo's [semantic versioning rules][cargo-semver].
At a minimum, it builds with the most recent Rust stable release minus
Expand Down

0 comments on commit 07be0a2

Please sign in to comment.