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.

Sign up for GitHub

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

Jump to bottom

Misleading documentation in Database.Persist.TH #967

Closed
hdgarrood opened this issue Oct 9, 2019 · 1 comment · Fixed by #968
Closed

Misleading documentation in Database.Persist.TH #967

hdgarrood opened this issue Oct 9, 2019 · 1 comment · Fixed by #968

Comments

@hdgarrood
Copy link
Contributor

The documentation for the module Database.Persist.TH has a module-level comment saying:

This module provides utilities for creating backends. Regular users do not need to use this module.

This doesn't seem right to me, since I would expect Database.Persist.TH to be used in almost every case by users to define their database schema. It's used in all of the examples in the yesod book chapter too. Should this comment be moved or removed?
@parsonsmatt
Copy link
Collaborator

Yeah that's definitely wrong! Thanks for catching that.

hdgarrood added a commit to hdgarrood/persistent that referenced this issue Oct 10, 2019
@hdgarrood
Update module comment in Database.Persist.TH
fb0e8e3 
Fixes yesodweb#967
@hdgarrood hdgarrood mentioned this issue Oct 10, 2019
Merged
2 tasks
hdgarrood added a commit to hdgarrood/persistent that referenced this issue Oct 10, 2019
@hdgarrood
Update changelog for yesodweb#967
132e70b
parsonsmatt pushed a commit that referenced this issue Oct 11, 2019
@hdgarrood @parsonsmatt
Update module comment in Database.Persist.TH (#968)
1d45c76 
* Update module comment in Database.Persist.TH

Fixes #967

* Update changelog for #967
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update module comment in Database.Persist.TH hdgarrood/persistent
2 participants
@hdgarrood @parsonsmatt