search

jfmengels / elm-review

Analyzes Elm projects, to help find mistakes before your users find them.
https://package.elm-lang.org/packages/jfmengels/elm-review/latest/
Other
252 stars 13 forks source link

Incomplete sentence in docs #164

Closed lydell closed 1 year ago

lydell commented 1 year ago

https://github.com/jfmengels/elm-review/blob/2.13.1/src/Review/Rule.elm#L1029-L1030

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#==).

There’s a sentence starting with “compared internally”. It looks like the start of the sentence has gone missing, or that a piece was left behind.

lue-bird commented 1 year ago

I think the missing part is

NOTE: Do not store functions, JSON values or regular expressions in your contexts, as they will be

https://github.com/jfmengels/elm-review/blob/2.13.1/src/Review/Rule.elm#L963

jfmengels commented 1 year ago

Thanks for reporting! The correct fix was actually to remove the "compared internally" sentence as that is only an issue for project contexts, not for module contexts.