Skip to content

Drop the Rep suffix from modules names? #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kl0tl opened this issue Dec 27, 2020 · 2 comments · Fixed by #33
Closed

Drop the Rep suffix from modules names? #32

kl0tl opened this issue Dec 27, 2020 · 2 comments · Fixed by #33

Comments

@kl0tl
Copy link
Contributor

kl0tl commented Dec 27, 2020

We renamed the Data.Generic.Rep.* modules to Data.*.Generic when porting generics-rep to prelude in purescript/purescript-prelude#235, so we should probably rename Data.Argonaut.Decode.Generic.Rep to Data.Argonaut.Decode.Generic, Data.Argonaut.Encode.Generic.Rep to Data.Argonaut.Encode.Generic and Data.Argonaut.Types.Generic.Rep to Data.Argonaut.Types.Generic when dropping generics-rep and updating the prelude dependency to its latest version.

@thomashoneyman
Copy link
Contributor

Yes; this seems like a good idea. Could you also add that change to the CHANGELOG?

@harryprayiv
Copy link

You should also update the ReadMe accordingly. As a labrador retreiver with a keyboard, figuring out how to import Rep took me half the day.
Here's what I ended up with:

import Data.Argonaut.Decode.Class (class DecodeJson)
import Data.Argonaut.Decode.Generic (class DecodeRep, genericDecodeJson)
import Data.Argonaut.Encode.Class (class EncodeJson)
import Data.Argonaut.Encode.Generic (genericEncodeJson)
import Data.Argonaut.Encode.Generic (class EncodeRep, genericEncodeJson)
import Data.Generic.Rep (class Generic)
import Data.Maybe (Maybe)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging a pull request may close this issue.

3 participants