From fde63554d8845776aafa9039e71106393a19c9d2 Mon Sep 17 00:00:00 2001 From: Techassi Date: Wed, 19 Feb 2025 15:50:37 +0100 Subject: [PATCH] docs: Simplify deprecated argument doc comments Signed-off-by: Techassi --- kube-derive/src/lib.rs | 26 ++++---------------------- 1 file changed, 4 insertions(+), 22 deletions(-) diff --git a/kube-derive/src/lib.rs b/kube-derive/src/lib.rs index 713afe750..c41098e3e 100644 --- a/kube-derive/src/lib.rs +++ b/kube-derive/src/lib.rs @@ -164,32 +164,14 @@ mod resource; /// ## `#[kube(deprecated [= "warning"])]` /// Sets the `deprecated` property to `true`. /// -/// ``` -/// # use serde::{Serialize, Deserialize}; -/// # use kube::core::{Resource, CustomResourceExt}; -/// # use kube_derive::CustomResource; -/// # use schemars::JsonSchema; -/// -/// #[derive(CustomResource, Clone, Debug, Deserialize, Serialize, JsonSchema)] -/// #[kube(group = "clux.dev", version = "v1", kind = "Foo", namespaced, deprecated)] -/// struct FooSpec { -/// info: String, -/// } +/// ```ignore +/// #[kube(deprecated)] /// ``` /// /// Optionally, the `deprecationWarning` property can be set using the following example. /// -/// ``` -/// # use serde::{Serialize, Deserialize}; -/// # use kube::core::{Resource, CustomResourceExt}; -/// # use kube_derive::CustomResource; -/// # use schemars::JsonSchema; -/// -/// #[derive(CustomResource, Clone, Debug, Deserialize, Serialize, JsonSchema)] -/// #[kube(group = "clux.dev", version = "v1", kind = "Foo", namespaced, deprecated = "my warning")] -/// struct FooSpec { -/// info: String, -/// } +/// ```ignore +/// #[kube(deprecated = "Replaced by other CRD")] /// ``` /// /// ## `#[kube(rule = Rule::new("self == oldSelf").message("field is immutable"))]`