From 61fe5ea0134d3d2365c525a4e1c75b21a152dffa Mon Sep 17 00:00:00 2001 From: Jeroen Engels Date: Thu, 22 Aug 2019 15:28:01 +0200 Subject: [PATCH] Add explanation as to why the Lint.Project module is available --- src/Lint/Project.elm | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/Lint/Project.elm b/src/Lint/Project.elm index 4343d060..53589965 100644 --- a/src/Lint/Project.elm +++ b/src/Lint/Project.elm @@ -6,6 +6,10 @@ module Lint.Project exposing {-| Represents project-related data, that a rule can access to get more information. +These will be accessible in rules with functions like [`Lint.Rule.withElmJsonVisitor`](./Lint-Rule#withElmJsonVisitor). +This module is made to build all of the project-related data that we want +rules to have access to, to later pass it to the [`Lint.lint`](./Lint#lint) function. + # Definition