diff options
author | John T. Wodder II <jwodder@users.noreply.github.com> | 2024-07-29 04:37:39 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-07-29 10:37:39 +0200 |
commit | 60a89c6491851b90890e2959f3aa46426ca59b41 (patch) | |
tree | ca8bf58f4c4e20f1c0b446e5e6d93d3bb9e4be19 | |
parent | 66b90cbe60ed3c88d38786f6cc32e482b56429cf (diff) |
Properly mark feature-gated functionality in docs (#662)
-rw-r--r-- | Cargo.toml | 2 | ||||
-rw-r--r-- | src/lib.rs | 11 | ||||
-rw-r--r-- | src/service/middleware/mod.rs | 1 |
3 files changed, 14 insertions, 0 deletions
@@ -15,6 +15,8 @@ keywords = ["github", "github-api"] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [package.metadata.docs.rs] +all-features = true +rustdoc-args = ["--cfg", "docsrs"] targets = ["x86_64-unknown-linux-gnu"] [dependencies] @@ -179,6 +179,7 @@ //! }; //! ``` #![cfg_attr(test, recursion_limit = "512")] +#![cfg_attr(docsrs, feature(doc_cfg))] mod api; mod body; @@ -341,6 +342,7 @@ pub async fn map_github_error( /// # } /// ``` #[cfg(feature = "default-client")] +#[cfg_attr(docsrs, doc(cfg(feature = "default-client")))] pub fn initialise(crab: Octocrab) -> Arc<Octocrab> { STATIC_INSTANCE.swap(Arc::from(crab)) } @@ -354,6 +356,7 @@ pub fn initialise(crab: Octocrab) -> Arc<Octocrab> { /// } /// ``` #[cfg(feature = "default-client")] +#[cfg_attr(docsrs, doc(cfg(feature = "default-client")))] pub fn instance() -> Arc<Octocrab> { STATIC_INSTANCE.load().clone() } @@ -503,6 +506,7 @@ impl<Svc, Config, LayerState> OctocrabBuilder<Svc, Config, NoAuth, LayerState> { impl OctocrabBuilder<NoSvc, DefaultOctocrabBuilderConfig, NoAuth, NotLayerReady> { /// Set the retry configuration #[cfg(feature = "retry")] + #[cfg_attr(docsrs, doc(cfg(feature = "retry")))] pub fn add_retry_config(mut self, retry_config: RetryConfig) -> Self { self.config.retry_config = retry_config; self @@ -510,6 +514,7 @@ impl OctocrabBuilder<NoSvc, DefaultOctocrabBuilderConfig, NoAuth, NotLayerReady> /// Set the connect timeout. #[cfg(feature = "timeout")] + #[cfg_attr(docsrs, doc(cfg(feature = "timeout")))] pub fn set_connect_timeout(mut self, timeout: Option<Duration>) -> Self { self.config.connect_timeout = timeout; self @@ -517,6 +522,7 @@ impl OctocrabBuilder<NoSvc, DefaultOctocrabBuilderConfig, NoAuth, NotLayerReady> /// Set the read timeout. #[cfg(feature = "timeout")] + #[cfg_attr(docsrs, doc(cfg(feature = "timeout")))] pub fn set_read_timeout(mut self, timeout: Option<Duration>) -> Self { self.config.read_timeout = timeout; self @@ -524,6 +530,7 @@ impl OctocrabBuilder<NoSvc, DefaultOctocrabBuilderConfig, NoAuth, NotLayerReady> /// Set the write timeout. #[cfg(feature = "timeout")] + #[cfg_attr(docsrs, doc(cfg(feature = "timeout")))] pub fn set_write_timeout(mut self, timeout: Option<Duration>) -> Self { self.config.write_timeout = timeout; self @@ -596,6 +603,7 @@ impl OctocrabBuilder<NoSvc, DefaultOctocrabBuilderConfig, NoAuth, NotLayerReady> } #[cfg(feature = "retry")] + #[cfg_attr(docsrs, doc(cfg(feature = "retry")))] pub fn set_connector_retry_service<S>( &self, connector: hyper_util::client::legacy::Client<S, OctoBody>, @@ -606,6 +614,7 @@ impl OctocrabBuilder<NoSvc, DefaultOctocrabBuilderConfig, NoAuth, NotLayerReady> } #[cfg(feature = "timeout")] + #[cfg_attr(docsrs, doc(cfg(feature = "timeout")))] pub fn set_connect_timeout_service<T>(&self, connector: T) -> TimeoutConnector<T> where T: Service<Uri> + Send, @@ -623,6 +632,7 @@ impl OctocrabBuilder<NoSvc, DefaultOctocrabBuilderConfig, NoAuth, NotLayerReady> /// Build a [`Client`] instance with the current [`Service`] stack. #[cfg(feature = "default-client")] + #[cfg_attr(docsrs, doc(cfg(feature = "defaut-client")))] pub fn build(self) -> Result<Octocrab> { let client: hyper_util::client::legacy::Client<_, OctoBody> = { #[cfg(all(not(feature = "opentls"), not(feature = "rustls")))] @@ -959,6 +969,7 @@ impl fmt::Debug for Octocrab { /// - `auth`: `None` /// - `client`: http client with the `octocrab` user agent. #[cfg(feature = "default-client")] +#[cfg_attr(docsrs, doc(cfg(feature = "default-client")))] impl Default for Octocrab { fn default() -> Self { OctocrabBuilder::default().build().unwrap() diff --git a/src/service/middleware/mod.rs b/src/service/middleware/mod.rs index 7dec247..c7846da 100644 --- a/src/service/middleware/mod.rs +++ b/src/service/middleware/mod.rs @@ -2,4 +2,5 @@ pub mod auth_header; pub mod base_uri; pub mod extra_headers; #[cfg(feature = "retry")] +#[cfg_attr(docsrs, doc(cfg(feature = "retry")))] pub mod retry; |