Skip to content

Commit

Permalink
Version bump
Browse files Browse the repository at this point in the history
Bump the version by changing the version number in the help text.

Include some documentation improvements in this commit (focussed on
clarity, brevity, and consistency), as well as an ordering fix in the
source code.
  • Loading branch information
ericcornelissen committed Jun 13, 2023
1 parent e3e7c40 commit 330275d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 17 deletions.
17 changes: 5 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ just ci-build

### Formatting

This project is formatted using rustfmt. Ensure all changes you commit are formatted. To format
This project is formatted using [rustfmt]. Ensure all changes you commit are formatted. To format
the source code run the command:

```shell
Expand Down Expand Up @@ -284,7 +284,7 @@ commands:
just coverage
```

This will generate a coverage report that can be found in the `_reports/coverage/` directory.
This will generate a coverage report which can be found in the `_reports/coverage/` directory.

If necessary you can configure the feature set to test using the `features` variable to adjust the
build, for example:
Expand All @@ -304,22 +304,15 @@ command:
just mutation
```
This will generate a mutation report in that can be found in the `_reports/mutants.out/` directory.
This will generate a mutation report which can be found in the `_reports/mutants.out/` directory.
You can configure the feature set to test using the `features` variable. This can be used to speed
up mutation testing if you're only interested in a particular piece of functionality. For example:
If necessary you can configure the feature set to mutation test using the `features` variable to
adjust the build, for example:
```shell
just features=gnu-mode mutation
```
You may need to use the `test_features` variable to catch all mutants since some functionality has
no or limited coverage without these. For example:

```shell
just test_features=test-trash mutation
```

#### Special Tests
##### `--trash` Tests
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ The development of this software is guided by the following principles:

- Defaults should be safe.
- Program output is for humans.
- Help the user to achieve what they want.
- Help the user achieve what they want.

### Sources of Inspiration

Expand Down
8 changes: 4 additions & 4 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ mod cli {
#[cfg(test)]
use proptest_derive::Arbitrary;

/// Remove (unlink) the PATH(s) - v23.04
/// Remove (unlink) the PATH(s) - v23.06
///
/// Does not remove anything by default, use either the option --force or --interactive to
/// perform the removal.
Expand Down Expand Up @@ -759,13 +759,13 @@ mod cli {
}
}

/// A standard environment variable name to enable verbose mode.
const DEBUG_MODE: &str = "DEBUG";

/// The environment variable name to enable compatibility mode with the GNU version of `rm(1)`.
#[cfg(feature = "gnu-mode")]
const GNU_MODE: &str = "RUST_RM_GNU_MODE";

/// A standard environment variable name to enable verbose mode.
const DEBUG_MODE: &str = "DEBUG";

/// Struct representing parsed environment configuration values.
#[cfg_attr(test, derive(Arbitrary, Clone, Copy, Debug))]
pub struct Vars {
Expand Down

0 comments on commit 330275d

Please sign in to comment.