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 #405

Draft
wants to merge 20 commits into
base: main
Choose a base branch
from

Conversation

kdayday
Copy link
Contributor

@kdayday kdayday commented Oct 18, 2024

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

Closes #403

Copy link

codecov bot commented Oct 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.75%. Comparing base (cd78bac) to head (4bbfa9c).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #405   +/-   ##
=======================================
  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% <ø> (ø)

@kdayday kdayday changed the title Documentation best practices guidelines Enforce strict docs compilation and add Documentation best practices guidelines Oct 24, 2024
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
1 participant