Skip to content
New issue

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

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

Already on GitHub? # to your account

Documentation clean up, update to Documenter 1.0, add *.md to formatter (PSY portion) #1176

Merged
merged 46 commits into from
Sep 23, 2024

Conversation

kdayday
Copy link
Contributor

@kdayday kdayday commented Aug 20, 2024

  • Update to documenter 1.0 with settings to error during compilation for everything except document size and missing docstrings
  • Add *.md files to formatter script and run formatter on documentation
  • Update dynamics data tutorial by merging with another tutorial in PSID
  • resolve missing docstrings list
    • adding missing PSY files to API (mostly dynamics devices)
    • removing IS from makedocs
    • selecting only the IS functions/types that are exported by PSY through a new filter function
  • make cost doc strings visible again after migration to IS
  • Make JSON serialization how-to have a realistic folder name instead of temp folder
  • expanded explanation on Per unit, which needs a review from someone else
  • resolve other asks from feedback from first documentation rewrite, including moving text and fixing/removing some examples that were erroring

Successful compilation with documenter 1.0 depends on docstring updates in IS NREL-Sienna/InfrastructureSystems.jl#394

Does not include moving the model library into API

Closes #1196

Copy link

codecov bot commented Aug 20, 2024

Codecov Report

Attention: Patch coverage is 33.33333% with 2 lines in your changes missing coverage. Please review.

Project coverage is 84.61%. Comparing base (fb41e06) to head (ba1a44d).
Report is 28 commits behind head on main.

Files with missing lines Patch % Lines
src/models/OuterControl.jl 33.33% 2 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1176      +/-   ##
==========================================
- Coverage   84.61%   84.61%   -0.01%     
==========================================
  Files         180      181       +1     
  Lines        8267     8285      +18     
==========================================
+ Hits         6995     7010      +15     
- Misses       1272     1275       +3     
Flag Coverage Δ
unittests 84.61% <33.33%> (-0.01%) ⬇️

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

Files with missing lines Coverage Δ
src/PowerSystems.jl 100.00% <ø> (ø)
src/models/branches.jl 100.00% <ø> (ø)
src/models/dynamic_generator.jl 84.37% <ø> (ø)
src/models/dynamic_inverter.jl 86.88% <ø> (ø)
src/models/generated/Line.jl 100.00% <ø> (ø)
src/models/generated/MonitoredLine.jl 94.28% <ø> (ø)
src/models/generated/PhaseShiftingTransformer.jl 94.28% <ø> (ø)
src/models/generated/TapTransformer.jl 100.00% <ø> (ø)
src/models/generated/Transformer2W.jl 100.00% <ø> (ø)
src/models/OuterControl.jl 64.70% <33.33%> (ø)

... and 3 files with indirect coverage changes

@kdayday kdayday changed the title WIP: Documentation clean up and update to Documenter 1.0 WIP: Documentation clean up and update to Documenter 1.0 (PSY portion) Aug 27, 2024
@kdayday kdayday changed the title WIP: Documentation clean up and update to Documenter 1.0 (PSY portion) WIP: Documentation clean up, update to Documenter 1.0, add *.md to formatter (PSY portion) Sep 2, 2024
@kdayday kdayday changed the title WIP: Documentation clean up, update to Documenter 1.0, add *.md to formatter (PSY portion) Documentation clean up, update to Documenter 1.0, add *.md to formatter (PSY portion) Sep 3, 2024
@kdayday kdayday marked this pull request as ready for review September 3, 2024 20:23
@kdayday kdayday requested a review from jd-lara September 3, 2024 20:23
docs/src/api/glossary.md Outdated Show resolved Hide resolved
docs/src/api/glossary.md Outdated Show resolved Hide resolved
docs/src/api/glossary.md Outdated Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rodrigomha who wrote this?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably me lol

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is some crazy text there lol

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anything else to change?

Copy link
Member

@jd-lara jd-lara left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should mention that the tabular data parser is about to disappear.

@kdayday
Copy link
Contributor Author

kdayday commented Sep 19, 2024

We should mention that the tabular data parser is about to disappear.

@jd-lara I split out the parsing how-to guide into separate topics, including a separate page on the tabular data parser with a warning at the top.

@kdayday
Copy link
Contributor Author

kdayday commented Sep 19, 2024

Codecov Report

Attention: Patch coverage is 33.33333% with 2 lines in your changes missing coverage. Please review.

Project coverage is 84.61%. Comparing base (3ce7468) to head (be03b71).
Report is 19 commits behind head on main.

Files with missing lines Patch % Lines
src/models/OuterControl.jl 33.33% 2 Missing ⚠️
Additional details and impacted files

I think the two setters I added are covered by test_accessors already

Copy link
Contributor

@rodrigomha rodrigomha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy with this PR to be merged

@jd-lara jd-lara merged commit 4e270f3 into NREL-Sienna:main Sep 23, 2024
9 of 10 checks passed
@kdayday kdayday deleted the docs_cleanup branch October 25, 2024 16:51
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: links to FuelCurve and CostCurve broken
3 participants