-
Notifications
You must be signed in to change notification settings - Fork 71
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
sweeping aside a documentation stumbling block for new people #108
Conversation
Also, please rebuild and push the documentation afterward, Hackage docs are broken for current version. New people won't know to walk the version back a notch. See here for example of manual doc pushing: https://github.com/bitemyapp/bloodhound/blob/master/Makefile#L27-L29 |
Would it make more sense to use |
@lpsmith Point of the change is to make the documented example "just work" for new people as it currently doesn't, I just tried what you suggested and the following happened:
|
You have an extra list type constructor, that should be only one set of brackets, not two.
|
@lpsmith I see now, I'll change accordingly.
But you should note that I didn't figure this out from the documentation. People cannot derive this stuff themselves if they didn't write the library. |
@lpsmith changed per recommendation, thanks :) |
I don't doubt the documentation could be better, and I do very much appreciate having a beginner look at this. But I would point out that despite a fair number of users, I don't get that many questions via email or IRC, and |
sweeping aside a documentation stumbling block for new people
Taken from paul-rouse/mysql-simple@620a639 Turns out that issue #108 was fixed in mysql-simple before postgresql-simple's first release, but before I started examining mysql-simple. So by some mechanism, I started work on postgresql-simple from a slightly out-of-date version of mysql-simple.
Cheers :)