Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs cleanup (IS portion) #394

Merged
merged 7 commits into from
Sep 3, 2024
Merged

Docs cleanup (IS portion) #394

merged 7 commits into from
Sep 3, 2024

Conversation

kdayday
Copy link
Contributor

@kdayday kdayday commented Aug 27, 2024

  • add docstrings for types that were missing in PSY (e.g., TimeSeriesKey)
  • fix broken reference links
  • update see also links for timeseries interface functions

Required for PSY docs to successfully compile in documenter 1.0 in NREL-Sienna/PowerSystems.jl#1176

Copy link

codecov bot commented Aug 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.28%. Comparing base (f6de7fd) to head (fefd03a).
Report is 8 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #394   +/-   ##
=======================================
  Coverage   78.28%   78.28%           
=======================================
  Files          71       71           
  Lines        5484     5484           
=======================================
  Hits         4293     4293           
  Misses       1191     1191           
Flag Coverage Δ
unittests 78.28% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
src/production_variable_cost_curve.jl 83.72% <ø> (ø)
src/static_time_series.jl 33.33% <ø> (ø)
src/system_data.jl 91.28% <ø> (ø)
src/time_series_interface.jl 95.58% <ø> (ø)
src/time_series_storage.jl 61.53% <ø> (ø)
src/time_series_structs.jl 92.85% <ø> (ø)
src/utils/logging.jl 91.50% <ø> (ø)
src/utils/recorder_events.jl 92.23% <ø> (ø)
src/value_curve.jl 93.00% <ø> (ø)

@kdayday kdayday changed the title WIP: Docs cleanup (IS portion) Docs cleanup (IS portion) Sep 3, 2024
@kdayday kdayday marked this pull request as ready for review September 3, 2024 19:55
@kdayday kdayday requested a review from jd-lara September 3, 2024 19:55
@jd-lara jd-lara merged commit 0816ef2 into NREL-Sienna:main Sep 3, 2024
9 checks passed
@kdayday kdayday deleted the docs_cleanup branch September 4, 2024 02:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants