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

Remove warnings in storing data in module contexts

Browse Source 
Fixes https://github.com/jfmengels/elm-review/issues/164
as that removes an incomplete sentence.
This commit is contained in:
Jeroen Engels 2023-08-12 10:34:36 +02:00
parent 88e7f8b375
commit 57fa48e5f2
2 changed files with 2 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs.json
View File

File diff suppressed because one or more lines are too long

6
src/Review/Rule.elm
View File

@ -960,9 +960,6 @@ what happens in other parts of the module. If you don't need a context, I
recommend specifying `()`, and using functions from this module with names recommend specifying `()`, and using functions from this module with names
starting with "withSimple". starting with "withSimple".
**NOTE**: Do not store functions, JSON values or regular expressions in your contexts, as they will be
compared internally, which [may cause Elm to crash](https://package.elm-lang.org/packages/elm/core/latest/Basics#==).
module My.Rule.Name exposing (rule) module My.Rule.Name exposing (rule)
import Review.Rule as Rule exposing (Rule) import Review.Rule as Rule exposing (Rule)
@ -1027,7 +1024,6 @@ newModuleRuleSchema name initialModuleContext =
{-| Same as [`newModuleRuleSchema`](#newModuleRuleSchema), except that you can request for data to help initialize the context. {-| Same as [`newModuleRuleSchema`](#newModuleRuleSchema), except that you can request for data to help initialize the context.
compared internally, which [may cause Elm to crash](https://package.elm-lang.org/packages/elm/core/latest/Basics#==).
module My.Rule.Name exposing (rule) module My.Rule.Name exposing (rule)
@ -1198,7 +1194,7 @@ The second argument is the initial `projectContext`, i.e. the data that the rule
accumulate as the project will be traversed, and allows the rule to know/remember accumulate as the project will be traversed, and allows the rule to know/remember
what happens in other parts of the project. what happens in other parts of the project.
**NOTE**: Do not store functions, JSON values or regular expressions in your contexts, as they will be **NOTE**: Do not store functions, JSON values or regular expressions in your project context, as they will be
compared internally, which [may cause Elm to crash](https://package.elm-lang.org/packages/elm/core/latest/Basics#==). compared internally, which [may cause Elm to crash](https://package.elm-lang.org/packages/elm/core/latest/Basics#==).
Project rules traverse the project in the following order: Project rules traverse the project in the following order: