Skip to content

Commit a83f3c4

Browse files
committed
Docs: don't use document-features as an example of optional feature
May confuse users who want to quickly copy paste Fixes #7
1 parent 5fb22ae commit a83f3c4

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Use `## ` and `#! ` comments in your Cargo.toml to document features, for exampl
1313

1414
```toml
1515
[dependencies]
16-
document-features = "0.1"
16+
document-features = "0.2"
1717
## ...
1818

1919
[features]

lib.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,12 @@ bar = []
6767
fusion = []
6868
6969
[dependencies]
70+
document-features = "0.2"
71+
7072
##! ### Optional dependencies
7173
72-
### Enable this when building the docs
73-
document-features = { version = "0.2", optional = true }
74+
### Enable this feature to implement the trait for the types from the genial crate
75+
genial = { version = "0.2", optional = true }
7476
7577
### This awesome dependency is specified in its own table
7678
[dependencies.awesome]
@@ -91,7 +93,7 @@ The following features are experimental
9193
⚠️ Can lead to explosions
9294
9395
#### Optional dependencies
94-
* **`document-features`** — Enable this when building the docs
96+
* **`genial`** — Enable this feature to implement the trait for the types from the genial crate
9597
9698
* **`awesome`** — This awesome dependency is specified in its own table
9799

0 commit comments

Comments
 (0)