Skip to content

Commit 975a65e

Browse files
committed
docs(stackable-versioned): Make k8s argument descriptions consistent.
I copy/pasted from the module docs to keep wrapping new-lines consistent.
1 parent 2278075 commit 975a65e

File tree

2 files changed

+22
-18
lines changed

2 files changed

+22
-18
lines changed

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

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,19 @@ use syn::Path;
88
///
99
/// Supported arguments are:
1010
///
11-
/// - `group`, which sets the CRD group, usually the domain of the company.
12-
/// - `kind`, which allows overwriting the kind field of the CRD. This defaults to the struct name
13-
/// (without the 'Spec' suffix).
14-
/// - `singular`, to specify the singular name of the CR object.
15-
/// - `plural`, to specify the plural name of the CR object.
16-
/// - `namespaced`, to specify that this is a namespaced resource rather than cluster level.
11+
/// - `group`: Set the group of the CR object, usually the domain of the company.
12+
/// This argument is Required.
13+
/// - `kind`: Override the kind field of the CR object. This defaults to the struct
14+
/// name (without the 'Spec' suffix).
15+
/// - `singular`: Set the singular name of the CR object.
16+
/// - `plural`: Set the plural name of the CR object.
17+
/// - `namespaced`: Indicate that this is a namespaced scoped resource rather than a
18+
/// cluster scoped resource.
1719
/// - `crates`: Override specific crates.
18-
/// - `status`: Sets the specified struct as the status subresource.
19-
/// - `shortname`: Sets a shortname for the CRD. This can be specified multiple times.
20-
/// - `skip`, which controls skipping parts of the generation.
20+
/// - `status`: Set the specified struct as the status subresource.
21+
/// - `shortname`: Set a shortname for the CR object. This can be specified multiple
22+
/// times.
23+
/// - `skip`: Controls skipping parts of the generation.
2124
#[derive(Clone, Debug, FromMeta)]
2225
pub(crate) struct KubernetesArguments {
2326
pub(crate) group: String,

crates/stackable-versioned-macros/src/lib.rs

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -603,16 +603,17 @@ println!("{}", serde_yaml::to_string(&merged_crd).unwrap());
603603
604604
Currently, the following arguments are supported:
605605
606-
- `group`: Sets the CRD group, usually the domain of the company.
607-
- `kind`: Allows overwriting the kind field of the CRD. This defaults
608-
to the struct name (without the 'Spec' suffix).
609-
- `singular`: Sets the singular name.
610-
- `plural`: Sets the plural name.
611-
- `namespaced`: Specifies that this is a namespaced resource rather than
612-
a cluster scoped.
606+
- `group`: Set the group of the CR object, usually the domain of the company.
607+
This argument is Required.
608+
- `kind`: Override the kind field of the CR object. This defaults to the struct
609+
name (without the 'Spec' suffix).
610+
- `singular`: Set the singular name of the CR object.
611+
- `plural`: Set the plural name of the CR object.
612+
- `namespaced`: Indicate that this is a namespaced scoped resource rather than a
613+
cluster scoped resource.
613614
- `crates`: Override specific crates.
614-
- `status`: Sets the specified struct as the status subresource.
615-
- `shortname`: Sets a shortname for the CRD. This can be specified multiple
615+
- `status`: Set the specified struct as the status subresource.
616+
- `shortname`: Set a shortname for the CR object. This can be specified multiple
616617
times.
617618
618619
### Versioning Items in a Module

0 commit comments

Comments
 (0)