Skip to content

Commit

Permalink
[Cleanup] FailurePersistence : update stale doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
matthew-russo committed Jul 15, 2023
1 parent f248d51 commit fed486a
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions proptest/src/test_runner/failure_persistence/file.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,11 @@ pub enum FileFailurePersistence {
/// `Direct("NUL")` on Windows (though it is internally handled by simply
/// not doing any I/O).
Off,
/// The path given to `TestRunner::set_source_file()` is parsed. The path
/// is traversed up the directory tree until a directory containing a file
/// named `lib.rs` or `main.rs` is found. A sibling to that directory with
/// the name given by the string in this configuration is created, and a
/// file with the same name and path relative to the source directory, but
/// with the extension changed to `.txt`, is used.
/// The path of the source file under test is traversed up the directory tree
/// until a directory containing a file named `lib.rs` or `main.rs` is found.
/// A sibling to that directory with the name given by the string in this
/// configuration is created, and a file with the same name and path relative
/// to the source directory, but with the extension changed to `.txt`, is used.
///
/// For example, given a source path of
/// `/home/jsmith/code/project/src/foo/bar.rs` and a configuration of
Expand All @@ -58,9 +57,9 @@ pub enum FileFailurePersistence {
/// If no source file has been configured, a warning is printed and this
/// behaves like `Off`.
SourceParallel(&'static str),
/// The path given to `TestRunner::set_source_file()` is parsed. The
/// extension of the path is changed to the string given in this
/// configuration, and that filename is used.
/// Failures are persisted in a file with the same path as the source file
/// under test, but the extension is changed to the string given in this
/// configuration.
///
/// For example, given a source path of
/// `/home/jsmith/code/project/src/foo/bar.rs` and a configuration of
Expand Down

0 comments on commit fed486a

Please sign in to comment.