Skip to content

Commit cb52840

Browse files
committed
docs(test): Expand docs for ProjectBuilder
1 parent 45f61cc commit cb52840

File tree

1 file changed

+9
-1
lines changed
  • crates/cargo-test-support/src

1 file changed

+9
-1
lines changed

crates/cargo-test-support/src/lib.rs

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,13 @@ pub struct Project {
233233

234234
/// Create a project to run tests against
235235
///
236-
/// The project can be constructed programmatically or from the filesystem with [`Project::from_template`]
236+
/// - Creates a [`basic_manifest`] if one isn't supplied
237+
///
238+
/// To get started, see:
239+
/// - [`project`]
240+
/// - [`project_in`]
241+
/// - [`project_in_home`]
242+
/// - [`Project::from_template`]
237243
#[must_use]
238244
pub struct ProjectBuilder {
239245
root: Project,
@@ -257,6 +263,7 @@ impl ProjectBuilder {
257263
self.root.target_debug_dir()
258264
}
259265

266+
/// Create project in `root`
260267
pub fn new(root: PathBuf) -> ProjectBuilder {
261268
ProjectBuilder {
262269
root: Project { root },
@@ -266,6 +273,7 @@ impl ProjectBuilder {
266273
}
267274
}
268275

276+
/// Create project, relative to [`paths::root`]
269277
pub fn at<P: AsRef<Path>>(mut self, path: P) -> Self {
270278
self.root = Project {
271279
root: paths::root().join(path),

0 commit comments

Comments
 (0)