Mention rule is autofixable

jfmengels · May 30, 2021 · e9874d0 · e9874d0
1 parent 025fbdd
commit e9874d0
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@ Provides [`elm-review`](https://package.elm-lang.org/packages/jfmengels/elm-revi
 
 ## Provided rules
 
-- [`Documentation.ReadmeLinksPointToCurrentVersion`](https://package.elm-lang.org/packages/jfmengels/elm-review-documentation/1.0.1/Documentation-ReadmeLinksPointToCurrentVersion) - Reports links in the `README.md` that do not point to the current version of the package.
+- [🔧 `Documentation.ReadmeLinksPointToCurrentVersion`](https://package.elm-lang.org/packages/jfmengels/elm-review-documentation/1.0.1/Documentation-ReadmeLinksPointToCurrentVersion "Provides automatic fixes") - Reports links in the `README.md` that do not point to the current version of the package.
 
 ## Configuration
 

diff --git a/src/Documentation/ReadmeLinksPointToCurrentVersion.elm b/src/Documentation/ReadmeLinksPointToCurrentVersion.elm
@@ -18,6 +18,8 @@ import Review.Rule as Rule exposing (Error, Rule)
 {-| Reports links in the `README.md` that point to this project's package documentation on <https://package.elm-lang.org/>,
 where the version is set to `latest` or a different version than the current version of the package.
 
+🔧 Running with `--fix` will automatically remove all the reported errors.
+
 The problem with linking to `latest` is that if you release a new version later,
 the users who read the README for the older version will be directed to a version
 where the module/function/section you pointed to may not exist anymore.