Skip to content
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

Lack of documentation #1

Open
tinco opened this issue Aug 30, 2015 · 1 comment
Open

Lack of documentation #1

tinco opened this issue Aug 30, 2015 · 1 comment

Comments

@tinco
Copy link

tinco commented Aug 30, 2015

This package looks really interesting, and I think I want to use it, but it's super low on documentation. Are you using this internally or was it just an experiment?

I read through the x.hs and the test, and it looks very neat, but I'm not a real haskell types wiz and I'm having trouble understanding what exactly it enables and how it does that.

If you could spare a little time to write perhaps just about the general idea of the library in a README.md I feel that would help a lot for potential users to understand it. If I do decide on using typed in my code generator then I'll be sure to file PR's with documentation as I get to know it :)

@NathanHowell
Copy link
Member

It is meant to replace some internal libraries, however i think it's still
missing the ability to invoke functions. The design I've had in mind
requires injective type families, a feature that will land in GHC 7.12.. so
I haven't been doing much with it for a while.

Most of the rest of the package won't change though so I really should
start documenting it :)
On Aug 30, 2015 4:47 AM, "Tinco Andringa" [email protected] wrote:

This package looks really interesting, and I think I want to use it, but
it's super low on documentation. Are you using this internally or was it
just an experiment?

I read through the x.hs and the test, and it looks very neat, but I'm not
a real haskell types wiz and I'm having trouble understanding what exactly
it enables and how it does that.

If you could spare a little time to write perhaps just about the general
idea of the library in a README.md I feel that would help a lot for
potential users to understand it. If I do decide on using typed in my code
generator then I'll be sure to file PR's with documentation as I get to
know it :)


Reply to this email directly or view it on GitHub
#1.

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

No branches or pull requests

2 participants