Skip to content

docs(snapbox): Clarify that 'current' macros use a heuristic #416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
epage merged 1 commit into from
Dec 26, 2025
Merged

docs(snapbox): Clarify that 'current' macros use a heuristic #416

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions crates/snapbox/src/macros.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,14 @@ macro_rules! assert_data_eq {
}

/// Find the directory for your source file
///
/// By default, a heuristic is used.
///
/// To override the heuristic, add to `$WORKSPACE_ROOT/.cargo/config.toml`:
/// ```toml
/// [env]
/// CARGO_RUSTC_CURRENT_DIR = { value = "", relative = true }
/// ```
#[doc(hidden)] // forced to be visible in intended location
#[macro_export]
macro_rules! current_dir {
Expand All @@ -60,6 +68,14 @@ macro_rules! current_dir {
}

/// Find the directory for your source file
///
/// By default, a heuristic is used.
///
/// To override the heuristic, add to `$WORKSPACE_ROOT/.cargo/config.toml`:
/// ```toml
/// [env]
/// CARGO_RUSTC_CURRENT_DIR = { value = "", relative = true }
/// ```
#[doc(hidden)] // forced to be visible in intended location
#[macro_export]
macro_rules! current_rs {
Expand All @@ -72,6 +88,14 @@ macro_rules! current_rs {
}

/// Find the base directory for [`std::file!`]
///
/// By default, a heuristic is used.
///
/// To override the heuristic, add to `$WORKSPACE_ROOT/.cargo/config.toml`:
/// ```toml
/// [env]
/// CARGO_RUSTC_CURRENT_DIR = { value = "", relative = true }
/// ```
#[doc(hidden)] // forced to be visible in intended location
#[macro_export]
macro_rules! cargo_rustc_current_dir {
Expand Down