transportenergy / database

Tools for accessing and maintaining the iTEM model & historical databases
https://transportenergy.rtfd.io
GNU General Public License v3.0
24 stars 8 forks source link

Extend documentation of historical.process() #63

Closed francescolovat closed 3 years ago

francescolovat commented 3 years ago

When trying to retrieve data from T000.csv, it was not fully clear how to do so in an efficient manner. When reading historical.process() docu, information about that function was missing and what was exactly the format of its argument id.

This PR extends its docstring and add example of id argument.

codecov[bot] commented 3 years ago

Codecov Report

Merging #63 (72e7fe7) into master (cbf4e1b) will not change coverage. The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #63   +/-   ##
=======================================
  Coverage   52.74%   52.74%           
=======================================
  Files          38       38           
  Lines        1583     1583           
=======================================
  Hits          835      835           
  Misses        748      748           
Impacted Files Coverage Δ
item/historical/__init__.py 92.47% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update cbf4e1b...49fc1ce. Read the comment docs.

khaeru commented 3 years ago

Thanks @francescolovat!

The check failures here are unrelated to your PR, so I will make another to fix them and then ask you to rebase.

khaeru commented 3 years ago

64 is merged, so please rebase.

francescolovat commented 3 years ago

64 is merged, so please rebase.

@khaeru thanks. Ready to merge once CIs will pass..

khaeru commented 3 years ago

The check failures here are because this a PR from a fork which has no access to the secret key used to upload data to our Google Cloud Storage bucket. I will open a separate issue to disable this.