Skip to content

docs: add fp-finder util sub command documentation #208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
S0obi wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: add fp-finder util sub command documentation #208

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
976295c
docs: add fp-finder util sub command documentation
S0obi Apr 26, 2025
a2ca011
Update content/6-development/6-2-crs-toolchain.md
S0obi Jan 12, 2026
7681891
Merge branch 'main' into docs/update-crs-toolchain-page
S0obi Jan 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion content/6-development/6-2-crs-toolchain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ The output should be:
The level of logging can be adjusted with the `--log-level` option. Accepted values are `trace`, `debug`, `info`, `warn`, `error`, `fatal`, `panic`, and `disabled`. The default level is `info`.

## Full Documentation

Read the built-in help text for the full documentation:

```bash
Expand Down Expand Up @@ -102,7 +103,10 @@ The `format` sub-command reports formatting violations and actively formats asse

## The `util` Command

The `util` command includes sub-commands that are used from time to time and do not fit nicely into any of the other groups. Currently, the only sub-command is `renumber-tests`. `renumber-tests` is used to simplify maintenance of the regression tests. Since every test has a consecutive number within its file, adding or removing tests can disrupt numbering. `renumber-tests` will renumber all tests within each test file consecutively.
The `util` command includes sub-commands that are used from time to time and do not fit nicely into any of the other groups. Currently, the available sub-commands are:

* `renumber-tests`: Used to simplify maintenance of the regression tests. Since every test has a consecutive number within its file, adding or removing tests can disrupt numbering. `renumber-tests` will renumber all tests within each test file consecutively.
* `fp-finder`: Takes a file as input and produces a filtered, alphabetically sorted list of unique words that are not present in the English dictionary (WordNet). This can help in identifying potential false positives by focusing on unusual or unknown words.

## The `completion` command

Expand Down