From 4cdde1ba684e68a6b12a7b56047bc6814a465fe7 Mon Sep 17 00:00:00 2001 From: Trenton H <797416+stumpylog@users.noreply.github.com> Date: Tue, 12 Dec 2023 09:12:56 -0800 Subject: [PATCH] Documents the new command optiion --- docs/administration.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/administration.md b/docs/administration.md index 808d6afaf..cf8a24294 100644 --- a/docs/administration.md +++ b/docs/administration.md @@ -607,3 +607,10 @@ document_fuzzy_match [--ratio] [--processes N] | ----------- | -------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | --ratio | No | 85.0 | a number between 0 and 100, setting how similar a document must be for it to be reported. Higher numbers mean more similarity. | | --processes | No | 1/4 of system cores | Number of processes to use for matching. Setting 1 disables multiple processes | +| --delete | No | False | If provided, one document of a matched pair above the ratio will be deleted. | + +!!! warning + + If providing the `--delete` option, it is highly recommended to have a backup. + While every effort has been taken to ensure proper operation, there is always the + chance of deletion of a file you want to keep.