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

Missing docs on proper usage #13

Open
xave opened this issue Sep 4, 2024 · 2 comments
Open

Missing docs on proper usage #13

xave opened this issue Sep 4, 2024 · 2 comments

Comments

@xave
Copy link

xave commented Sep 4, 2024

It would be nice if there were a fleshed out example and navigable types on hackage.

https://www.youtube.com/watch?v=_ZE6qO489b0

This video reverse engineered a lot of things, but it could be easier to onboard.

@xave
Copy link
Author

xave commented Sep 5, 2024

I think a complete example with best practices on getting database configs from environment would go a long way. The test suite does have a complete-ish example usage. Except for the simple "database=test" connection line.

@xave
Copy link
Author

xave commented Sep 5, 2024

There should also be an example of loading multiple scripts in one directory in the test suite as that is actual usage. Right now, mds is just a single script. I'd say that's a gap in coverage because how do you know you've tested for that common case?

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

1 participant