jfmengels/elm-review
1
1
Fork 0
mirror of https://github.com/jfmengels/elm-review.git synced 2024-11-28 00:56:51 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for phantom types

Browse Source
This commit is contained in:
Jeroen Engels 2020-03-19 23:55:36 +01:00
parent 6f73e42b9a
commit 9bf286c02b
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/Review/Rule.elm
View File

@ -6,10 +6,10 @@ module Review.Rule exposing
, withModuleDefinitionVisitor, withCommentsVisitor, withImportVisitor, Direction(..), withDeclarationVisitor, withDeclarationListVisitor, withExpressionVisitor, withFinalModuleEvaluation
, withElmJsonModuleVisitor, withReadmeModuleVisitor, withDependenciesModuleVisitor
, ProjectRuleSchema, newProjectRuleSchema, fromProjectRuleSchema, withModuleVisitor, withModuleContext, withElmJsonProjectVisitor, withReadmeProjectVisitor, withDependenciesProjectVisitor, withFinalProjectEvaluation, withContextFromImportedModules
, Required, NotNeeded
, Error, error, errorRuleName, errorMessage, errorDetails, errorRange, errorFixes, errorFilePath, ModuleKey, errorForModule, ElmJsonKey, errorForElmJson, ReadmeKey, errorForReadme
, withFixes
, ignoreErrorsForDirectories, ignoreErrorsForFiles
, Required, NotNeeded
)
{-| This module contains functions that are used for writing rules.
@ -192,7 +192,6 @@ Evaluating/visiting a node means two things:
## Creating a project rule
@docs ProjectRuleSchema, newProjectRuleSchema, fromProjectRuleSchema, withModuleVisitor, withModuleContext, withElmJsonProjectVisitor, withReadmeProjectVisitor, withDependenciesProjectVisitor, withFinalProjectEvaluation, withContextFromImportedModules
@docs Required, NotNeeded
## Errors
@ -225,6 +224,11 @@ reason or seemingly inappropriately.
@docs ignoreErrorsForDirectories, ignoreErrorsForFiles
# Internals
@docs Required, NotNeeded
-}
import Dict exposing (Dict)
@ -981,13 +985,13 @@ withModuleVisitor visitor (ProjectRuleSchema schema) =
ProjectRuleSchema { schema | moduleVisitor = HasVisitors (visitor :: previousModuleVisitors) }
{-| TODO Documentation
{-| Used for phantom type constraints. You can safely ignore this type.
-}
type Required
= Required
{-| TODO Documentation
{-| Used for phantom type constraints. You can safely ignore this type.
-}
type NotNeeded
= NotNeeded