Skip to content

Commit

Permalink
Docs: don't use document-features as an example of optional feature
Browse files Browse the repository at this point in the history
May confuse users who want to quickly copy paste

Fixes #7
  • Loading branch information
ogoffart committed Jul 25, 2022
1 parent 5fb22ae commit a83f3c4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Use `## ` and `#! ` comments in your Cargo.toml to document features, for exampl

```toml
[dependencies]
document-features = "0.1"
document-features = "0.2"
## ...

[features]
Expand Down
8 changes: 5 additions & 3 deletions lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,12 @@ bar = []
fusion = []
[dependencies]
document-features = "0.2"
##! ### Optional dependencies
### Enable this when building the docs
document-features = { version = "0.2", optional = true }
### Enable this feature to implement the trait for the types from the genial crate
genial = { version = "0.2", optional = true }
### This awesome dependency is specified in its own table
[dependencies.awesome]
Expand All @@ -91,7 +93,7 @@ The following features are experimental
⚠️ Can lead to explosions
#### Optional dependencies
* **`document-features`** — Enable this when building the docs
* **`genial`** — Enable this feature to implement the trait for the types from the genial crate
* **`awesome`** — This awesome dependency is specified in its own table
Expand Down

0 comments on commit a83f3c4

Please sign in to comment.