Skip to content

Commit 2b812a6

Browse files
committed
Improved feature documentation
1 parent 73575da commit 2b812a6

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A library for comparing the ordering of variables and producing useful error mes
1010
This library is based on the struct [`ComparisonError`], which can be used to compare the partial ordering
1111
of two to three variables of any type `T` which implements the [`PartialOrd`] trait. If the comparison evaluates
1212
to false, [`ComparisonError`] can be formatted into a nice error message. To simplify the usage, the procedural
13-
macro [`compare_variables`] is provided via the feature flag **proc_macro** (enabled by default).
13+
macro [`compare_variables`] is provided via the feature flag `proc_macro` (enabled by default).
1414

1515
The full API documentation is available at [https://docs.rs/compare_variables/0.2.0/compare_variables/](https://docs.rs/compare_variables/0.2.0/compare_variables/).
1616

@@ -53,7 +53,7 @@ assert_eq!(err.to_string(), "`arg (value: 1) > 2 > z (value: 3)` is false");
5353

5454
# Usage without the procedural macro
5555

56-
In order to minimize dependencies, it is possible to use this crate without the **proc_macro** feature flag.
56+
In order to minimize dependencies, it is possible to use this crate without the `proc_macro ` feature flag.
5757
Please see the docstring of [`ComparisonError`] for details.
5858

5959
```rust

src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ assert_eq!(err.to_string(), "`x (value: 1) > y (value: 2)` is false");
6060
## Construction via macro
6161
6262
It is recommended to use the procedural macro [`compare_variables`] to construct this struct
63-
(available via the feature flag **proc_macro** which is enabled by default). With the macro,
63+
(available via the feature flag `proc_macro ` which is enabled by default). With the macro,
6464
the previous example is simplified to:
6565
```
6666
use compare_variables::compare_variables;

0 commit comments

Comments
 (0)