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

Lack of documentation #156

Open
victor1234 opened this issue Mar 6, 2018 · 3 comments
Open

Lack of documentation #156

victor1234 opened this issue Mar 6, 2018 · 3 comments

Comments

@victor1234
Copy link

There is no complete documentation and reference. How to help fix it?

@zauguin
Copy link
Collaborator

zauguin commented Mar 7, 2018

The current approach of writing everything into the README doesn't really scale.
I personally would like using Standardese for the reference documentation. Maybe you or @aminroosta have other suggestions?

If we go down this route and you are into CMake, it would be awesome if you could integrate this into the new build system in the develop branch.
Alternatively you could start writing documentation comments for some functions. They don't have to be perfect yet, but it would get the ball rolling.

@DBJDBJ
Copy link

DBJDBJ commented Nov 13, 2018

This is/was a great effort of a few good people. +1 for that.

The key top-level architectural view is missing. Inevitably, it appears (at least to me) this lib is way overengineered. But looking into the code only, it is impossible to be certain. A proper white paper (a lot of diagrams please, but not from the code) might remedy this.

@Xeverous
Copy link

Xeverous commented Dec 1, 2018

For sure a more detailed doc is needed. Examples don't even fully cover obtaining results or the mapping between SQL return types vs types supported by >>.

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

4 participants