feat: rename cli arg --no-web-links to --offline becheran#37

hoijui · Nov 13, 2022 · cee03eb · cee03eb
1 parent a1aaaaf
commit cee03eb
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/docs/reference.md b/docs/reference.md
@@ -6,7 +6,7 @@
 |------------------|-------|-------------|
 | `--help`         | `-h`  | Print help |
 | `--debug`        | `-d`  | Show verbose debug information |
-| `--no-web-links` |       | Do not check any web links |
+| `--offline`      |       | Do not check any web links. Renamed from `--no-web-links` which is still an alias for downwards compatibility |
 | `--match-file-extension`|| Set the flag, if the file extension shall be checked as well. For example the following markup link `[link](dir/file)` matches if for example a file called `file.md` exists in `dir`, but would fail when the `--match-file-extension` flag is set. |
 | `--version`      | `-V`  | Print current version of mlc |
 | `--ignore-path`  |       | List of directories or files which shall be ignored. |

diff --git a/src/cli.rs b/src/cli.rs
@@ -25,8 +25,9 @@ pub fn parse_args() -> Config {
                 .required(false),
         )
         .arg(
-            Arg::with_name("no_web_links")
-                .long("no-web-links")
+            Arg::with_name("offline")
+                .alias("no-web-links")
+                .long("offline")
                 .help("Do not check web links")
                 .required(false),
         )