Skip to content

Commit 29aed25

Browse files
committed
chore(docs): Adjust wording
1 parent c320e8e commit 29aed25

File tree

1 file changed

+8
-9
lines changed
  • crates/stackable-versioned-macros/src

1 file changed

+8
-9
lines changed

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

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -368,15 +368,14 @@ mod consts;
368368
///
369369
/// ## Auto-generated `From` Implementations
370370
///
371-
/// To enable smooth version upgrades of the same container, the macro
372-
/// automatically generates `From` implementations. On a high level, code
373-
/// generated for two versions _a_ and _b_, with _a < b_ looks like this:
374-
/// `impl From<a> for b`. As you can see, only upgrading is currently supported.
375-
/// Downgrading from a higher version to a lower one is not supported at the
376-
/// moment.
371+
/// To enable smooth container version upgrades, the macro automatically
372+
/// generates `From` implementations. On a high level, code generated for two
373+
/// versions _a_ and _b_, with _a < b_ looks like this: `impl From<a> for b`.
374+
/// As you can see, only upgrading is currently supported. Downgrading from a
375+
/// higher version to a lower one is not supported at the moment.
377376
///
378-
/// This automatic generation can be skipped to for example enable a custom
379-
/// implementation for more complex conversions.
377+
/// This automatic generation can be skipped to enable a custom implementation
378+
/// for more complex conversions.
380379
///
381380
/// ### Skipping at the Container Level
382381
///
@@ -428,7 +427,7 @@ mod consts;
428427
/// ## Kubernetes-specific Features
429428
///
430429
/// This macro also offers support for Kubernetes-specific versioning,
431-
/// especially for CustomResourceDefinitions, short CRDs. These features are
430+
/// especially for CustomResourceDefinitions (CRDs). These features are
432431
/// completely opt-in. You need to enable the `k8s` feature (which enables
433432
/// optional dependencies) and use the `k8s()` parameter in the macro.
434433
///

0 commit comments

Comments
 (0)