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

Adding Examples of Unit Model Costing Documentation #1373

Merged
merged 15 commits into from
May 10, 2024

Conversation

MarcusHolly
Copy link
Contributor

Fixes/Resolves:

Issue #1360

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 self-assigned this May 2, 2024
@ksbeattie ksbeattie added 1.0 Hard requirement for the 1.0 release Priority:High High Priority Issue or PR labels May 2, 2024
@MarcusHolly MarcusHolly marked this pull request as ready for review May 2, 2024 20:14
Copy link

codecov bot commented May 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.84%. Comparing base (4c0d270) to head (29a443a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1373   +/-   ##
=======================================
  Coverage   93.84%   93.84%           
=======================================
  Files         339      339           
  Lines       35890    35890           
=======================================
  Hits        33682    33682           
  Misses       2208     2208           

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

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.

General comment: superscripts and subscripts are not showing correctly un USD and in the parameter description. Also couldn't find CSTR, CSTR injection in the docs

@MarcusHolly MarcusHolly mentioned this pull request May 6, 2024
28 tasks
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

Copy link
Contributor

@savannahsakhai savannahsakhai left a comment

Choose a reason for hiding this comment

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

LGTM, my only suggestion would be to delete the section in the CSTR page mentioned in my comment.

Copy link
Contributor

Choose a reason for hiding this comment

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

References

Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values

This section needs to be removed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for catching this - I just forgot to add it.

@lbianchi-lbl lbianchi-lbl enabled auto-merge (squash) May 10, 2024 16:35
@lbianchi-lbl lbianchi-lbl merged commit c2ee96c into watertap-org:main May 10, 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 Priority:High High Priority Issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants