Skip to content

Commit 4c67dbd

Browse files
docs(stackable-versioned): Update usage guide (#864)
* docs(stackable-versioned): Update usage guide * docs: Add action specific docs, add K8s docs * chore: Add validation TODOs * docs: Update top-level crate docs * docs: Hide unused trait * chore: Apply suggestions Co-authored-by: Nick <[email protected]> * chore(docs): Adjust wording --------- Co-authored-by: Nick <[email protected]>
1 parent 17054c3 commit 4c67dbd

File tree

5 files changed

+371
-115
lines changed

5 files changed

+371
-115
lines changed

crates/stackable-versioned-macros/Cargo.toml

+4
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ license.workspace = true
66
edition.workspace = true
77
repository.workspace = true
88

9+
# Enable all features to ensure content appears in the online documentation.
10+
[package.metadata."docs.rs"]
11+
all-features = true
12+
913
# cargo-udeps throws an error that these dependencies are unused. They are,
1014
# however, used in K8s specific test cases. This is a false-positive and an
1115
# apparent limitation of cargo-udeps. These entries can be removed once

crates/stackable-versioned-macros/src/attrs/common/item.rs

+5
Original file line numberDiff line numberDiff line change
@@ -296,6 +296,7 @@ impl ItemAttributes {
296296
}
297297
}
298298

299+
// TODO (@Techassi): Add validation for when default_fn is "" (empty path).
299300
/// For the added() action
300301
///
301302
/// Example usage:
@@ -317,6 +318,10 @@ fn default_default_fn() -> SpannedValue<Path> {
317318
)
318319
}
319320

321+
// TODO (@Techassi): Add validation for when from_name AND from_type are both
322+
// none => is this action needed in the first place?
323+
// TODO (@Techassi): Add validation that the from_name mustn't include the
324+
// deprecated prefix.
320325
/// For the changed() action
321326
///
322327
/// Example usage:

0 commit comments

Comments
 (0)