Skip to content

Commit da383e2

Browse files
committed
credentials: Reword docs and comments
1 parent de1ba64 commit da383e2

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

oauth-credentials/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@
1111

1212
## Stability
1313

14-
The goal of `oauth-credentials` is to provide a stable foundation for OAuth
15-
implementations.
14+
The goal of `oauth-credentials` is to provide a stable and interoperable
15+
foundation for OAuth implementations.
1616

17-
The crate is still unstable in the sense of Semantic Versioning. However, we
17+
However, the crate is still unstable in the sense of Semantic Versioning. But we
1818
are not planning to make any breaking change and are going to publish the API
1919
as it is as version 1.0.0 using the [semver trick] unless we find a flaw in the
2020
API significant enough to justify a breaking change.
@@ -43,7 +43,7 @@ Feature | MSRV
4343

4444
Note that if your crate uses the `serde` feature (even if optionally!), it
4545
cannot be compiled directly with Rust 1.7.x and older due to
46-
[rust-lang/cargo#3763], but it can somehow be compiled as a non-root node of a
47-
dependency tree.
46+
[rust-lang/cargo#3763], but it can somehow be compiled as a dependency of
47+
another crate if the feature is disabled.
4848

4949
[rust-lang/cargo#3763]: https://github.com/rust-lang/cargo/issues/3763

oauth-credentials/src/lib.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ pub struct Credentials<T = String> {
5454
// XXX: These almost-identical (modulo default type param) items should certainly be defined with a
5555
// macro, but doing so would break the build on toolchains prior to nightly-2016-05-29 (7746a334d).
5656
// Maybe <https://github.com/rust-lang/rust/pull/33926> is relevant?
57+
// Also, `<#[cfg(feature = "alloc")] T = String, #[cfg(not(feature = "alloc"))] T>` cannot be used
58+
// on toolchains prior to 1.27.0.
5759

5860
/// An OAuth "credentials" pair defined in [RFC 5849 section 1.1][rfc].
5961
///

0 commit comments

Comments
 (0)