rusqlite_migration icon indicating copy to clipboard operation
rusqlite_migration copied to clipboard

Contribute to the documentation

Open cljoly opened this issue 4 years ago • 2 comments

As someone who isn’t the author of this, you have super powers! You can see what is unclear in the documentation.

So please, when you try to use this library, if you notice anything unclear in the README or the docs, comment on this issue or open a PR, so that other people would find their way more easily. Thanks a lot!

cljoly avatar Oct 03 '21 10:10 cljoly

Hi there, first of all thanks for your work! I just stumbled across this line on the top level documentation of the crate:

conn.pragma_update(None, "journal_mode", &"WAL").unwrap();

This panics for me with ExecuteReturnedResults. According to this issue in rusqlite we have to use pragma_update_and_check instead.

So probably the easiest way to fix the documentation would be to change that line to: conn.pragma_update_and_check(None, "journal_mode", &"WAL", |_| Ok(())).unwrap();

beingflo avatar Dec 24 '23 14:12 beingflo

Thanks for your kind words and for reporting this. I started looking into this, I'll open a PR soon (my goal is to catch similar problems in CI in the future).

cljoly avatar Jan 04 '24 07:01 cljoly