vertica-python
vertica-python copied to clipboard
vertica
Extensive documentation missing
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.
@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!
@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.
@Dschoni That's great. Please assign yourself as the assignee of this issue if you would like to produce the documentation. Thank you again!
Hello, I am looking for my first contribution (and I've been using vertica-python recently). Make I ask what is the status with Documentation. Is any help needed (I would probably need a little bit of guidance). Thanks.
