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

Enforce strict docs compilation and add Documentation best practices guidelines #419

Merged
merged 43 commits into from
Dec 24, 2024

Conversation

kdayday
Copy link
Contributor

@kdayday kdayday commented Dec 17, 2024

  • Add missing docstrings from InfrastructureSystems.Simulation and InfrastructureSystems.Optimization submodules
  • Now enforces and passes Documenter.jl >1.0 quality control checks
  • Documentation best practices added

Closes #403

@kdayday kdayday requested review from jd-lara, kennedy-mindermann and rodrigomha and removed request for jd-lara December 17, 2024 21:36
Copy link

codecov bot commented Dec 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.75%. Comparing base (cd78bac) to head (f813192).
Report is 44 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #419   +/-   ##
=======================================
  Coverage   77.75%   77.75%           
=======================================
  Files          69       69           
  Lines        5481     5481           
=======================================
  Hits         4262     4262           
  Misses       1219     1219           
Flag Coverage Δ
unittests 77.75% <ø> (ø)

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

Files with missing lines Coverage Δ
src/Optimization/optimization_problem_results.jl 0.00% <ø> (ø)

Copy link

@kennedy-mindermann kennedy-mindermann left a comment

Choose a reason for hiding this comment

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

Looks good to me

@kdayday kdayday merged commit 180ab67 into main Dec 24, 2024
10 checks passed
@kdayday kdayday deleted the kd/docs_bp branch December 24, 2024 00:56
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.

Write a Best Practices docs
2 participants