From 4f78137271361008e5c600582e9c683ddea0d08e Mon Sep 17 00:00:00 2001 From: Eirik A Date: Sun, 1 Sep 2024 21:53:49 +0100 Subject: [PATCH] fix new doc clippy lint (#1567) Signed-off-by: clux --- kube-client/src/config/file_config.rs | 4 ++-- kube-client/src/config/mod.rs | 5 ++++- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/kube-client/src/config/file_config.rs b/kube-client/src/config/file_config.rs index 7e31018ae..e6bf934c1 100644 --- a/kube-client/src/config/file_config.rs +++ b/kube-client/src/config/file_config.rs @@ -543,8 +543,8 @@ impl AuthInfo { } } -/// Cluster stores information to connect Kubernetes cluster used with auth plugins -/// that have `provideClusterInfo`` enabled. +/// Connection information for auth plugins that have `provideClusterInfo` enabled. +/// /// This is a copy of [`kube::config::Cluster`] with certificate_authority passed as bytes without the path. /// Taken from [clientauthentication/types.go#Cluster](https://github.com/kubernetes/client-go/blob/477cb782cf024bc70b7239f0dca91e5774811950/pkg/apis/clientauthentication/types.go#L73-L129) #[derive(Clone, Debug, Serialize, Deserialize, Default)] diff --git a/kube-client/src/config/mod.rs b/kube-client/src/config/mod.rs index c51daebd7..d7c891a23 100644 --- a/kube-client/src/config/mod.rs +++ b/kube-client/src/config/mod.rs @@ -1,4 +1,7 @@ -//! Kubernetes configuration objects from `~/.kube/config`, `$KUBECONFIG`, or the [cluster environment](https://kubernetes.io/docs/tasks/access-application-cluster/access-cluster/#accessing-the-api-from-a-pod). +//! Kubernetes configuration objects. +//! +//! Reads locally from `$KUBECONFIG` or `~/.kube/config`, +//! and in-cluster from the [pod environment](https://kubernetes.io/docs/tasks/run-application/access-api-from-pod/#accessing-the-api-from-within-a-pod). //! //! # Usage //! The [`Config`] has several constructors plus logic to infer environment.