Skip to content

Commit e35355f

Browse files
committed
cargo-rbmt: beef up the api's implicit dep requirement docs
1 parent 91491fb commit e35355f

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

cargo-rbmt/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,9 @@ When you specify `--lock-file`, the tool copies that lock file to `Cargo.lock` b
151151

152152
## API
153153

154-
The `api` command helps maintain API stability by generating public API snapshots and checking for breaking changes. It uses the [public-api](https://github.com/Enselic/cargo-public-api) crate to analyze a crate's public interface. **Requires running with a nightly toolchain after nightly-2025-08-02** due to docsrs dependencies.
154+
The `api` command helps maintain API stability by generating public API snapshots and checking for breaking changes. It uses the [public-api](https://github.com/Enselic/cargo-public-api) crate to analyze a crate's public interface.
155+
156+
> **NOTE:** `api` has an implicit dependency on the version of the nightly toolchain since it relies on an unstable docsrs interface. Currently, it requires [*nightly-2025-08-02* or later](https://github.com/cargo-public-api/cargo-public-api/blob/main/README.md#compatibility-matrix).
155157
156158
```bash
157159
cargo rbmt api

0 commit comments

Comments
 (0)