Skip to content

Commit e2eed77

Browse files
committed
chore: Add missing doc comments for supported K8s arguments
1 parent 626915a commit e2eed77

File tree

1 file changed

+6
-0
lines changed
  • crates/stackable-versioned-macros/src/attrs

1 file changed

+6
-0
lines changed

crates/stackable-versioned-macros/src/attrs/k8s.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,17 @@ use darling::{util::Flag, FromMeta};
22

33
/// This struct contains supported Kubernetes arguments.
44
///
5+
/// The arguments are passed through to the `#[kube]` attribute. More details can be found in the
6+
/// official docs: <https://docs.rs/kube/latest/kube/derive.CustomResource.html>.
7+
///
58
/// Supported arguments are:
69
///
710
/// - `skip`, which controls skipping parts of the generation.
11+
/// - `singular`, to specify the singular name of the CR object.
12+
/// - `plural`, to specify the plural name of the CR object.
813
/// - `kind`, which allows overwriting the kind field of the CRD. This defaults to the struct name
914
/// (without the 'Spec' suffix).
15+
/// - `namespaced`, to specify that this is a namespaced resource rather than cluster level.
1016
/// - `group`, which sets the CRD group, usually the domain of the company.
1117
#[derive(Clone, Debug, FromMeta)]
1218
pub(crate) struct KubernetesArguments {

0 commit comments

Comments
 (0)