From a67b51323883d0aa34feb3c93b3b9dc6596cafa9 Mon Sep 17 00:00:00 2001 From: Andy Grunwald Date: Sun, 23 Oct 2022 12:17:20 +0200 Subject: [PATCH] Extend description of "--exclude" to also exclude email addresses, not only URLs (#801) --- README.md | 2 +- fixtures/configs/smoketest.toml | 2 +- lychee-bin/src/options.rs | 2 +- lychee.example.toml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6aca1a1..8bae0ba 100644 --- a/README.md +++ b/README.md @@ -243,7 +243,7 @@ OPTIONS: Equivalent to `--exclude-private --exclude-link-local --exclude-loopback` --exclude - Exclude URLs from checking (supports regex) + Exclude URLs and mail addresses from checking (supports regex) --exclude-file Deprecated; use `--exclude-path` instead diff --git a/fixtures/configs/smoketest.toml b/fixtures/configs/smoketest.toml index 597674b..7eb0d93 100644 --- a/fixtures/configs/smoketest.toml +++ b/fixtures/configs/smoketest.toml @@ -87,7 +87,7 @@ include_verbatim = false # Ignore case of paths when matching glob patterns. glob_ignore_case = false -# Exclude URLs from checking (supports regex). +# Exclude URLs and mail addresses from checking (supports regex). exclude = [ '.*\.github.com\.*' ] # Exclude these filesystem paths from getting checked. diff --git a/lychee-bin/src/options.rs b/lychee-bin/src/options.rs index 3d9da32..1c4bd7c 100644 --- a/lychee-bin/src/options.rs +++ b/lychee-bin/src/options.rs @@ -216,7 +216,7 @@ pub(crate) struct Config { #[serde(default)] pub(crate) include: Vec, - /// Exclude URLs from checking (supports regex) + /// Exclude URLs and mail addresses from checking (supports regex) #[clap(long)] #[serde(default)] pub(crate) exclude: Vec, diff --git a/lychee.example.toml b/lychee.example.toml index 88425d8..ad787ca 100644 --- a/lychee.example.toml +++ b/lychee.example.toml @@ -86,7 +86,7 @@ include_verbatim = false # Ignore case of paths when matching glob patterns. glob_ignore_case = false -# Exclude URLs from checking (supports regex). +# Exclude URLs and mail addresses from checking (supports regex). exclude = [ '.*\.github.com\.*' ] # Exclude these filesystem paths from getting checked.