search

haskell / aeson

A fast Haskell JSON library
Other
1.25k stars 321 forks source link

Docs regression (2.2.0.0): lazy-ByteString `decode` and `decodeEither` now documented as strict #1052

Closed PiDelport closed 1 year ago

PiDelport commented 1 year ago

It looks like this is what happened:

  1. https://github.com/haskell/aeson/pull/996 added new implementations of the lazy-ByteString decode and eitherDecode functions in Data.Aeson.Decoding, but accidentally copied the doc comments from their strict counterparts. (diff link)

  2. https://github.com/haskell/aeson/pull/1036 replaced the old (2.1.2.1) decode and eitherDecode functions in Data.Aeson with the new ones above.

These are the old (2.1.2.1) definitions and docs, for reference:

I'm not sure whether the docs should simply be reverted, or whether the new implementations warrant updated docs. Thoughts?

phadej commented 1 year ago

I'll welcome the s/strict/lazy/ patch if there is such mistake.