search

BritishGeologicalSurvey / etlhelper

ETL Helper is a Python ETL library to simplify data transfer into and out of databases.
https://britishgeologicalsurvey.github.io/etlhelper/
GNU Lesser General Public License v3.0
104 stars 25 forks source link

Document individual functions #126

Closed rbroth closed 2 years ago

rbroth commented 2 years ago

It would be useful to have a list of functions and methods in library, aling with their arguments, what they return, and what they do. Similar to how methods are documented for e.g. node-oracledb

volcan01010 commented 2 years ago

Definitely. Getting proper documentation has been on the TODO list for a while and is the main outstanding task before we go to v1.0. It will make etlhelper much more accessible.

This is the original ticket: https://github.com/BritishGeologicalSurvey/etlhelper/issues/12

I'd hoped to get that done by Easter. Now I hope to get it done this summer. Seeing as you have expressed an interest, I may rope you in to help... ;)

volcan01010 commented 2 years ago

The best description of the functions for now is in the source code itself. The functions are defined here: https://github.com/BritishGeologicalSurvey/etlhelper/blob/main/etlhelper/etl.py

The plan is to use the Sphinx tool to autogenerate a webpage from those definitions and doc strings.