From 3dff0ec945a44fd10f2875f1589c133f27e546db Mon Sep 17 00:00:00 2001 From: Ed Page Date: Thu, 18 Jul 2024 16:37:18 -0500 Subject: [PATCH] docs(test): Document project* functions --- crates/cargo-test-support/src/lib.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/crates/cargo-test-support/src/lib.rs b/crates/cargo-test-support/src/lib.rs index 929f86f00..51feea408 100644 --- a/crates/cargo-test-support/src/lib.rs +++ b/crates/cargo-test-support/src/lib.rs @@ -524,17 +524,17 @@ impl Project { } } -// Generates a project layout +/// Generates a project layout, see [`ProjectBuilder`] pub fn project() -> ProjectBuilder { ProjectBuilder::new(paths::root().join("foo")) } -// Generates a project layout in given directory +/// Generates a project layout in given directory, see [`ProjectBuilder`] pub fn project_in(dir: &str) -> ProjectBuilder { ProjectBuilder::new(paths::root().join(dir).join("foo")) } -// Generates a project layout inside our fake home dir +/// Generates a project layout inside our fake home dir, see [`ProjectBuilder`] pub fn project_in_home(name: &str) -> ProjectBuilder { ProjectBuilder::new(paths::home().join(name)) }