elm-community / json-extra

Convenience functions for working with Json.
http://package.elm-lang.org/packages/elm-community/json-extra/latest
MIT License
37 stars 16 forks source link

The documentation for (|:) is too long #2

Closed crazymykl closed 7 years ago

crazymykl commented 7 years ago

This makes tooling such as autocomplete very cumbersome. Maybe reduce it to a paragraph and have the explanation in a linked blog post or gist?

lukewestby commented 7 years ago

That's a good point, I'm always super annoyed when my autocomplete boxes cover the whole screen. I like the idea of having separate page for long-form documentation. I think the plan will be to have a separate markdown file in this repo that doc comments can link to. That change will happen with the release for Elm 0.18, which should be very soon.

Thanks!