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 uses cross-ref to math docs & collapsed admonitions #656

Merged
merged 5 commits into from
Sep 5, 2024

Conversation

brynpickering
Copy link
Member

@brynpickering brynpickering commented Aug 7, 2024

Fixes #651
Fixes point 3 in #643

Summary of changes in this pull request

  • Added Uses which is the inverse of Used in
  • Added collapsed admonitions for Uses and Used in when building math docs with mkdocs features enabled
  • Explicitly removed self-references in Uses and Used in

Reviewer checklist

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

@brynpickering
Copy link
Member Author

@sstroemer I can't add you as a review (will fix this), but welcome your comments

Copy link

codecov bot commented Aug 7, 2024

Codecov Report

Attention: Patch coverage is 75.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 95.98%. Comparing base (c3d6c4c) to head (0db5e0e).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/calliope/backend/latex_backend_model.py 75.00% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main     #656   +/-   ##
=======================================
  Coverage   95.97%   95.98%           
=======================================
  Files          26       26           
  Lines        3980     3981    +1     
  Branches      836      768   -68     
=======================================
+ Hits         3820     3821    +1     
  Misses         70       70           
  Partials       90       90           
Files with missing lines Coverage Δ
src/calliope/backend/latex_backend_model.py 96.85% <75.00%> (+0.01%) ⬆️

@sstroemer
Copy link
Contributor

That is really fancy! 😲


Just one minor thing I noticed - you mentioned something related to "order of the entries" somewhere previously, not sure where exactly - when looking at flow_cap, it lists:

  1. flow_capacity_per_storage_capacity_min
  2. ramping_down
  3. area_use_per_flow_capacity
  4. ...

All of those are constraints, but are neither in the order that they appear in base.yaml, nor some other order I could guess (for stuff like flow_cap_min it also lists variables before constraints)? Maybe sticking to the same order as in the sidebar (if possible) would make it easier to read?

@brynpickering
Copy link
Member Author

Maybe sticking to the same order as in the sidebar (if possible) would make it easier to read?

I have changed it to alphabetical because getting it in the same order as given in the math docs is a bit difficult.
I have also alphabetically sorted the math docs in general. It is reasier to navigate (as you previously suggested @sstroemer) and it probably doesn't matter about getting the order right for defining global expressions as that isn't really what's important when communicating the math in this way.

sjpfenninger
sjpfenninger previously approved these changes Aug 30, 2024
Copy link
Member

@sjpfenninger sjpfenninger left a comment

Choose a reason for hiding this comment

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

Looks fantastic.

@brynpickering brynpickering merged commit 3cd8caf into main Sep 5, 2024
13 checks passed
@brynpickering brynpickering deleted the update-math-docs-cross-refs branch September 5, 2024 16:19
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.

Possible duplicate links
3 participants