Skip to content

Commit

Permalink
docs(stackable-versioned): Update usage guide (#864)
Browse files Browse the repository at this point in the history
* 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]>
  • Loading branch information
Techassi and NickLarsenNZ authored Sep 12, 2024
1 parent 17054c3 commit 4c67dbd
Show file tree
Hide file tree
Showing 5 changed files with 371 additions and 115 deletions.
4 changes: 4 additions & 0 deletions crates/stackable-versioned-macros/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ license.workspace = true
edition.workspace = true
repository.workspace = true

# Enable all features to ensure content appears in the online documentation.
[package.metadata."docs.rs"]
all-features = true

# cargo-udeps throws an error that these dependencies are unused. They are,
# however, used in K8s specific test cases. This is a false-positive and an
# apparent limitation of cargo-udeps. These entries can be removed once
Expand Down
5 changes: 5 additions & 0 deletions crates/stackable-versioned-macros/src/attrs/common/item.rs
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,7 @@ impl ItemAttributes {
}
}

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

// TODO (@Techassi): Add validation for when from_name AND from_type are both
// none => is this action needed in the first place?
// TODO (@Techassi): Add validation that the from_name mustn't include the
// deprecated prefix.
/// For the changed() action
///
/// Example usage:
Expand Down
Loading

0 comments on commit 4c67dbd

Please sign in to comment.