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

Add param default and type to math docs #690

Merged
merged 2 commits into from
Sep 30, 2024
Merged

Conversation

brynpickering
Copy link
Member

Fixes #677

Summary of changes in this pull request

  • Piped parameter "default" through to math docs
  • Added parameter "type" to math docs

Reviewer checklist

  • Test(s) added to cover contribution
  • Documentation updated
  • Changelog updated
  • Coverage maintained or improved

Copy link
Contributor

@irm-codebase irm-codebase left a comment

Choose a reason for hiding this comment

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

Looking good. I've added a small question about the values we fetch from the schema.
Once that's answered I'll approve.

Checked:

  • Documentation changes.
  • Added type checks to the math documentation.

src/calliope/backend/latex_backend_model.py Show resolved Hide resolved
@irm-codebase irm-codebase self-requested a review September 30, 2024 18:55
Copy link
Contributor

@irm-codebase irm-codebase left a comment

Choose a reason for hiding this comment

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

given the discussion, I am approving this PR

@brynpickering brynpickering merged commit 99e5211 into main Sep 30, 2024
11 checks passed
@brynpickering brynpickering deleted the add-math-param-default branch September 30, 2024 19:01
Copy link

codecov bot commented Sep 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.98%. Comparing base (e447d17) to head (91c229b).
Report is 19 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #690   +/-   ##
=======================================
  Coverage   95.98%   95.98%           
=======================================
  Files          26       26           
  Lines        3981     3985    +4     
  Branches      837      769   -68     
=======================================
+ Hits         3821     3825    +4     
  Misses         70       70           
  Partials       90       90           
Files with missing lines Coverage Δ
src/calliope/backend/backend_model.py 97.97% <100.00%> (+<0.01%) ⬆️
src/calliope/backend/latex_backend_model.py 96.91% <100.00%> (+0.05%) ⬆️

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.

Show parameter defaults and typing in the base math section.
2 participants