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

Documentation suggestion: Mention "sql" quasiquoter in haddock intro overview doc #254

Open
bitc opened this issue Apr 21, 2018 · 1 comment

Comments

@bitc
Copy link

bitc commented Apr 21, 2018

Multi-line SQL string literals are practically a must, even for simple programs.

Luckily, this library comes with the "sql" quasiquoter for handling this. Unfortunately, this is hidden away in the module Database.PostgreSQL.Simple.SqlQQ And this is among many other modules, that look like they are only for advanced functionality, so it is not clearly visible.

I was actually using a different haskell library for doing multiline SQL strings with postgresql-simple, because I didn't realize that "sql" existed. It was only by accident that I discovered it existed.

I suggest adding to the haddock overview in Database.PostgreSQL.Simple a section that mentions this feature (perhaps with the subheading "Multi-line SQL queries"), with a short example of how to use it.

Thank you

@lpsmith
Copy link
Owner

lpsmith commented Aug 13, 2018

Sounds like a great idea! I'll try to get this done for the next release, though I don't know when that might happen.

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