From cbc5c8bd65f6daae7dc49b0c1d6ee58646a130f3 Mon Sep 17 00:00:00 2001 From: Rain Date: Wed, 25 Dec 2024 01:59:04 +0000 Subject: [PATCH] readme fixups --- README.md | 14 +++++++------- src/lib.rs | 14 +++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index aaea08c5b..11072f6d1 100644 --- a/README.md +++ b/README.md @@ -48,8 +48,8 @@ datatest_stable::harness! { of: * `fn(&Path) -> datatest_stable::Result<()>` - * `fn(&Utf8Path) -> datatest_stable::Result<()>` (`Utf8Path` is part of the - [`camino`](https://docs.rs/camino) library, and is re-exported here for convenience.) + * `fn(&Utf8Path) -> datatest_stable::Result<()>` ([`Utf8Path`](https://docs.rs/camino/1.1.9/camino/struct.Utf8Path.html) is part of the + [`camino`](https://docs.rs/camino/1.1.9/camino/index.html) library, and is re-exported here for convenience.) * `fn(&P, String) -> datatest_stable::Result<()>` where `P` is `Path` or `Utf8Path`. If the extra `String` parameter is specified, the contents of the file will be loaded and passed in as a string (erroring out if that failed). @@ -61,14 +61,14 @@ datatest_stable::harness! { the crate’s `Cargo.toml` is located). Absolute paths are not supported, and will panic at runtime. - `root` is an arbitrary expression that implements `Display`, such as `&str`, or a - function call that returns a `Utf8PathBuf`. + `root` is an arbitrary expression that implements + [`Display`](https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html), such as `&str`, or a function call that + returns a [`Utf8PathBuf`](https://docs.rs/camino/1.1.9/camino/struct.Utf8PathBuf.html). * `pattern` - a regex used to match against and select each file to be tested. Extended regexes - with lookaround and backtracking are supported via the - [`fancy_regex`](https://docs.rs/fancy-regex) crate. + with lookaround and backtracking are supported via the [`fancy_regex`](https://docs.rs/fancy-regex/0.14.0/fancy_regex/index.html) crate. - `pattern` is an arbitrary expression that implements `Display`, such as + `pattern` is an arbitrary expression that implements [`Display`](https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html), such as `&str`, or a function call that returns a `String`. The three parameters can be repeated if you have multiple sets of data-driven tests to be run: diff --git a/src/lib.rs b/src/lib.rs index d54da8943..1beeeb814 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -41,8 +41,8 @@ //! * `test` - The test function to be executed on each matching input. This function can be one //! of: //! * `fn(&Path) -> datatest_stable::Result<()>` -//! * `fn(&Utf8Path) -> datatest_stable::Result<()>` (`Utf8Path` is part of the -//! [`camino`](https://docs.rs/camino) library, and is re-exported here for convenience.) +//! * `fn(&Utf8Path) -> datatest_stable::Result<()>` ([`Utf8Path`](camino::Utf8Path) is part of the +//! [`camino`] library, and is re-exported here for convenience.) //! * `fn(&P, String) -> datatest_stable::Result<()>` where `P` is `Path` or `Utf8Path`. If the //! extra `String` parameter is specified, the contents of the file will be loaded and passed in //! as a string (erroring out if that failed). @@ -55,14 +55,14 @@ //! the crate's `Cargo.toml` is located). Absolute paths are not supported, and //! will panic at runtime. //! -//! `root` is an arbitrary expression that implements `Display`, such as `&str`, or a -//! function call that returns a `Utf8PathBuf`. +//! `root` is an arbitrary expression that implements +//! [`Display`](std::fmt::Display), such as `&str`, or a function call that +//! returns a [`Utf8PathBuf`](camino::Utf8PathBuf). //! //! * `pattern` - a regex used to match against and select each file to be tested. Extended regexes -//! with lookaround and backtracking are supported via the -//! [`fancy_regex`](https://docs.rs/fancy-regex) crate. +//! with lookaround and backtracking are supported via the [`fancy_regex`] crate. //! -//! `pattern` is an arbitrary expression that implements `Display`, such as +//! `pattern` is an arbitrary expression that implements [`Display`](std::fmt::Display), such as //! `&str`, or a function call that returns a `String`. //! //! The three parameters can be repeated if you have multiple sets of data-driven tests to be run: