The Public Utility Data Liberation Project provides analysis-ready energy system data to climate advocates, researchers, policymakers, and journalists.
The draft documentation, written using ReStructured Text, is successfully building on Read The Docs, and all the docstrings conform to the Google Style guide, which can be translated automatically by Sphinx into reST. However, the contents of the doc strings often needs to be fleshed out -- especially the module and sub-package level docstrings, which are often only a single line and give no overview of the module.
A punchlist of all API elements to be distributed:
cmgosnell
commented
4 years ago
The draft documentation, written using ReStructured Text, is successfully building on Read The Docs, and all the docstrings conform to the Google Style guide, which can be translated automatically by Sphinx into reST. However, the contents of the doc strings often needs to be fleshed out -- especially the module and sub-package level docstrings, which are often only a single line and give no overview of the module.
A punchlist of all API elements to be distributed:
pudl.analysis.mcoepudl.analysispudl.clipudl.constantspudl.convert.epacems_to_parquetpudl.convert.ferc1_to_sqlitepudl.convertpudl.datastore.clipudl.datastore.datastorepudl.datastorepudl.etl_pkg(will be re-named topudl.etl)pudl.extract.eia860pudl.extract.eia923pudl.extract.epacemspudl.extract.epaipmpudl.extract.ferc1pudl.extractpudl.glue.ferc1_eiapudl.gluepudl.helperspudl.init(to be removed)pudl.loadpudl.output.eia860pudl.output.eia923pudl.output.exportpudl.output.ferc1pudl.output.gluepudl.output.pudltablpudl.outputpudlpudl.settingspudl.transform.eia860pudl.transform.eia923pudl.transform.eiapudl.transform.epacemspudl.transform.epaipmpudl.transform.ferc1pudl.transform