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

Extensive documentation missing #226

Open
Dschoni opened this issue Aug 20, 2018 · 3 comments
Open

Extensive documentation missing #226

Dschoni opened this issue Aug 20, 2018 · 3 comments
Assignees

Comments

@Dschoni
Copy link

Dschoni commented Aug 20, 2018

As maintenance of this project seems to be clear now, I would like to ask, where documentation is happening (in order to facilitate contribution). So far, I only found the quickstart documentation inside the readme on the github project page, which I find to be insufficient (compared to the extensive documentation of the very similar psycopg2 postgreSQL adapter).

Furthermore, there is no information on this in the Contributing guidelines.

@sitingren
Copy link
Member

@Dschoni For now, unfortunately, there are only quick-start documentation in the README. We understand how important it is for contributors and we agree it is a must-have for this project. We plan to create a extensive documentation using Sphinx in the near future. Thank you for your interest!

@Dschoni
Copy link
Author

Dschoni commented Aug 22, 2018

@sitingren I suggest following the community optimised numpydoc standard, documented at https://numpydoc.readthedocs.io/en/latest/format.html . This is being used all over numpy and scipy, integrates well with sphinx and popular IDEs such as pycharm and spyder (which comes with Anaconda). I'm interested in helping to produce such a documentation.

@sitingren
Copy link
Member

@Dschoni That's great. Please assign yourself as the assignee of this issue if you would like to produce the documentation. Thank you again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants