search

sparksp / elm-review-ports

Provides elm-review rules to detect errant elm ports.
https://package.elm-lang.org/packages/sparksp/elm-review-ports/latest/
MIT License
2 stars 0 forks source link

Ports should always have documentation #9

Open sparksp opened 4 years ago

sparksp commented 4 years ago

I don't want to have to go out from our Elm files to find where a port is being used most of the time. Simply adding a line or two explaining what the port triggers, or where the values coming in from a port can help a lot.

Ref: NoRedInk Elm style guide

sparksp commented 4 years ago

Currently blocked by https://github.com/stil4m/elm-syntax/issues/35 as there is no easy access to documentation for ports.

sparksp commented 4 years ago

Will be fixed in elm-syntax v8.0.0.

sparksp commented 3 years ago

This should be covered by Docs.NoMissing.