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

Some documentation fixes #377

Merged
merged 9 commits into from
Nov 25, 2022
Merged

Some documentation fixes #377

merged 9 commits into from
Nov 25, 2022

Conversation

cbielow
Copy link
Contributor

@cbielow cbielow commented Nov 21, 2022

We have successfully used SQLiteCPP to transition from QtSql to your implementation with great success.
Thank you for developing SQLiteCPP :)

During our switch I came across some minor stuff, mostly concerning documentation, most of which is addressed in this PR.
In a few places I extended the docs to mention the underlying sqlite3 function, since it was not clear (to me) what was actually happening until I looked at the implementation. This may be different for experts in sqlite, but I only use it occasionally and found it more convenient if SQLiteCPP docs gave me as much information as possible.

Please let me know if this is desirable. I can revert things if you feel its too much detail.

One minor thing (which I did not fix): the documentation gets build in the source tree, instead of the build tree.
Is that intentional?

Thanks again for a great library!

@SRombauts SRombauts self-assigned this Nov 25, 2022
@SRombauts
Copy link
Owner

Thanks for contributing all these improvements :)

About the documentation, I just set it up initially by copying from another of my C++ projects and didn't give it too many thoughts after that.
If it's useful to you and you have ideas on how it should be, feel free to propose :)

@SRombauts SRombauts merged commit a32e884 into SRombauts:master Nov 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants