Skip to content

Commit 837bee1

Browse files
committed
docs(materialized_artifact): drop artifact! macro doc; restore ENV_PREFIX doc
1 parent 5145e20 commit 837bee1

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

  • crates
    • materialized_artifact_build/src
    • materialized_artifact/src

crates/materialized_artifact/src/lib.rs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,6 @@ pub struct Artifact {
4242
hash: &'static str,
4343
}
4444

45-
/// Construct an [`Artifact`] from the env vars published by a build script
46-
/// via `materialized_artifact_build::register`. Must match the `ENV_PREFIX`
47-
/// constant in `materialized_artifact_build`.
4845
#[macro_export]
4946
macro_rules! artifact {
5047
($name:literal) => {

crates/materialized_artifact_build/src/lib.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
use std::{fs, path::Path};
22

3+
/// Namespace prefix for the env vars set by [`register`] and consumed by
4+
/// `materialized_artifact`'s `artifact!` macro. Exported so both crates agree
5+
/// on the same prefix.
36
pub const ENV_PREFIX: &str = "MATERIALIZED_ARTIFACT_";
47

58
/// Publish an artifact at `path` so `materialized_artifact`'s `artifact!($name)`

0 commit comments

Comments
 (0)