Skip to content

Commit

Permalink
Fix minor doc issues
Browse files Browse the repository at this point in the history
  • Loading branch information
ramosbugs committed May 3, 2021
1 parent 406d8d8 commit da322f5
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,24 +19,24 @@
//! * [OpenID Connect Discovery document](#openid-connect-discovery-document)
//! * [OpenID Connect Discovery JSON Web Key Set](#openid-connect-discovery-json-web-key-set)
//! * [OpenID Connect ID Token](#openid-connect-id-token)
//! * [Async/Await API](#asyncawait-api)
//! * [Asynchronous API](#asynchronous-api)
//!
//! # Importing `openidconnect`: selecting an HTTP client interface
//!
//! This library offers a flexible HTTP client interface with two modes:
//! * **Synchronous (blocking)**
//! * **Async/await**
//! * **Asynchronous**
//!
//! For the HTTP client modes described above, the following HTTP client implementations can be
//! used:
//! * **[`reqwest`]**
//!
//! The `reqwest` HTTP client supports both modes. By default, `reqwest` 0.10 is enabled,
//! which supports the synchronous and asynchronous `futures` 0.1 APIs.
//! The `reqwest` HTTP client supports both the synchronous and asynchronous modes and is enabled
//! by default.
//!
//! Synchronous client: [`reqwest::http_client`]
//!
//! Async/await `futures` 0.3 client: [`reqwest::async_http_client`]
//! Asynchronous client: [`reqwest::async_http_client`]
//!
//! * **[`curl`]**
//!
Expand All @@ -49,19 +49,21 @@
//!
//! In addition to the clients above, users may define their own HTTP clients, which must accept
//! an [`HttpRequest`] and return an [`HttpResponse`] or error. Users writing their own clients
//! may wish to disable the default `reqwest` 0.10 dependency by specifying
//! `default-features = false` in `Cargo.toml`:
//! may wish to disable the default `reqwest` dependency by specifying
//! `default-features = false` in `Cargo.toml` (replacing `...` with the desired version of this
//! crate):
//! ```toml
//! openidconnect = { version = "1.0", default-features = false }
//! openidconnect = { version = "...", default-features = false }
//! ```
//!
//! Synchronous HTTP clients should implement the following trait:
//! ```ignore
//! ```text,ignore
//! FnOnce(HttpRequest) -> Result<HttpResponse, RE>
//! where RE: std::error::Error + 'static
//! ```
//!
//! Async/await `futures` 0.3 HTTP clients should implement the following trait:
//! ```ignore
//! Asynchronous HTTP clients should implement the following trait:
//! ```text,ignore
//! FnOnce(HttpRequest) -> F
//! where
//! F: Future<Output = Result<HttpResponse, RE>>,
Expand Down Expand Up @@ -446,7 +448,7 @@
//! # }
//! ```
//!
//! # Async/Await API
//! # Asynchronous API
//!
//! An asynchronous API for async/await is also provided.
//!
Expand Down Expand Up @@ -1126,10 +1128,10 @@ where
///
/// Creates a request builder for revoking a previously received token.
///
/// Requires that [`set_revocation_url()`](Self::set_revocation_url()) have already been called to set the
/// Requires that [`set_revocation_uri()`](Self::set_revocation_uri()) have already been called to set the
/// revocation endpoint URL.
///
/// Attempting to submit the generated request without calling [`set_revocation_url()`](Self::set_revocation_url())
/// Attempting to submit the generated request without calling [`set_revocation_uri()`](Self::set_revocation_uri())
/// first will result in an error.
///
/// See https://tools.ietf.org/html/rfc7009
Expand Down

0 comments on commit da322f5

Please sign in to comment.