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

Documentation? #1

Open
kamakazikamikaze opened this issue Jun 3, 2015 · 3 comments
Open

Documentation? #1

kamakazikamikaze opened this issue Jun 3, 2015 · 3 comments

Comments

@kamakazikamikaze
Copy link

I know that this isn't the most "fun" thing to do but could you add documentation/comments to all of your source code? I understand that it is based on the RethinkDB Python driver but it would be helpful having it within the source itself. That way hints and descriptions that pull up in IDEs, or just browsing the source code, makes it easier to understand on-the-fly

@AtnNn
Copy link
Owner

AtnNn commented Jun 6, 2015

@kamakazikamikaze I'll add some comments to the code.

Which IDE are you using? What style of comments would be best for the hints you mention?

@AtnNn
Copy link
Owner

AtnNn commented Jun 6, 2015

I've added a few comments in 0d41413. I've also made it possible to include the comments from the Python driver into rethinkdb.h.

It would be possible to use the code from the test suite to convert the examples in the docs from Python to C++, and then add a test the makes sure it results in valid queries. But that would be a lot more work.

Let me know if you have any questions.

@duzy
Copy link

duzy commented Sep 20, 2016

It's hard to use this library without documents or examples.

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

3 participants