docs

[jd-lara]

This PR documents the features in InfrastructureSystems. Preview here https://nrel-siip.github.io/InfrastructureSystems.jl/previews/PR166/

[codecov[bot]]

Codecov Report

Merging #166 into pre-10 will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           pre-10     #166   +/-   ##
=======================================
  Coverage   70.23%   70.23%           
=======================================
  Files          41       41           
  Lines        2587     2587           
=======================================
  Hits         1817     1817           
  Misses        770      770           

Impacted Files	Coverage Δ
src/components.jl	90.21% <ø> (ø)
src/utils/logging.jl	90.00% <ø> (ø)
src/utils/recorder_events.jl	90.00% <ø> (ø)
src/utils/utils.jl	52.40% <ø> (ø)

[daniel-thom]

Something that is not addressed here but can be addressed separately is coverage of the interface functions that are defined in InfrastructureSystems but then exported in PowerSystems. An example is get_time_series(T, component). If other packages use InfrastructureSystems then it would be good to have all of that type of direct user-facing documentation defined in one place and let the parent packages refer to it.

[jd-lara]

Something that is not addressed here but can be addressed separately is coverage of the interface functions that are defined in InfrastructureSystems but then exported in PowerSystems. An example is get_time_series(T, component). If other packages use InfrastructureSystems then it would be good to have all of that type of direct user-facing documentation defined in one place and let the parent packages refer to it.

I think this is true, the current version is just a first organized version with a valid version of the content. We can add more later. I think we should keep a Jira issue with the missing documentation.