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

Update Costing Doc Automation #1394

Merged
merged 11 commits into from
May 22, 2024

Conversation

MarcusHolly
Copy link
Contributor

@MarcusHolly MarcusHolly commented May 20, 2024

Summary/Motivation:

In the unit model costing documentation there was a column named "Default Value" under the Costing Method Variables section. Since this column does not make sense for many of these variables, this column has been changed to "Index". This PR also changes the variable and parameter names to the monospacing font to distinguish them from regular text.

Changes proposed in this PR:

  • "Default Value" column changed to "Index" in unit model costing documentation template
  • Variable and Parameter names changed to monospacing font in unit model costing documentation template
  • Updates existing unit model costing documentation to use monospacing font for Vars and Params

Legal Acknowledgement

By contributing to this software project, I agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the license terms described in the LICENSE.txt file at the top level of this directory.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

@MarcusHolly MarcusHolly added Priority:Normal Normal Priority Issue or PR 1.0 Hard requirement for the 1.0 release labels May 20, 2024
@MarcusHolly MarcusHolly self-assigned this May 20, 2024
@MarcusHolly MarcusHolly marked this pull request as ready for review May 20, 2024 13:34
@MarcusHolly MarcusHolly added the documentation Improvements or additions to documentation label May 20, 2024
Copy link
Contributor

@agarciadiego agarciadiego left a comment

Choose a reason for hiding this comment

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

LGTM

@hunterbarber
Copy link
Contributor

@MarcusHolly I think you're the author of all the existing cost docs in main as of now which already have this change applied?

@MarcusHolly
Copy link
Contributor Author

@MarcusHolly I think you're the author of all the existing cost docs in main as of now which already have this change applied?

I also didn't touch documentation that are currently in open PRs (GAC, Electrolyzer, and crystallizer), but those all adhere to this format now as well

Copy link

codecov bot commented May 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.02%. Comparing base (f8a9e29) to head (c527812).
Report is 58 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1394   +/-   ##
=======================================
  Coverage   94.02%   94.02%           
=======================================
  Files         335      335           
  Lines       35620    35620           
=======================================
  Hits        33491    33491           
  Misses       2129     2129           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bknueven bknueven enabled auto-merge (squash) May 22, 2024 14:23
@bknueven bknueven merged commit 3cf1fb8 into watertap-org:main May 22, 2024
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.0 Hard requirement for the 1.0 release documentation Improvements or additions to documentation Priority:Normal Normal Priority Issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants