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 documentation for LSRRO flowsheet #1450

Merged
merged 15 commits into from
Jun 27, 2024

Conversation

ElmiraShamlou
Copy link
Contributor

@ElmiraShamlou ElmiraShamlou commented Jun 24, 2024

Addresses: #1219 for LSRRO

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.

@ElmiraShamlou ElmiraShamlou self-assigned this Jun 24, 2024
@ElmiraShamlou ElmiraShamlou added the Priority:High High Priority Issue or PR label Jun 24, 2024
@ElmiraShamlou ElmiraShamlou added the 1.0 Hard requirement for the 1.0 release label Jun 24, 2024
Copy link

codecov bot commented Jun 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.94%. Comparing base (3785348) to head (a9b1691).
Report is 30 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1450   +/-   ##
=======================================
  Coverage   93.94%   93.94%           
=======================================
  Files         310      310           
  Lines       33206    33206           
=======================================
  Hits        31194    31194           
  Misses       2012     2012           

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

Copy link
Contributor

@MarcusHolly MarcusHolly left a comment

Choose a reason for hiding this comment

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

A couple of minor suggestions

ElmiraShamlou and others added 5 commits June 25, 2024 13:58
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Copy link
Contributor

@MarcusHolly MarcusHolly left a comment

Choose a reason for hiding this comment

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

A couple more instances where dimensionless needs to be added

ElmiraShamlou and others added 3 commits June 25, 2024 14:10
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Copy link
Contributor

@MarcusHolly MarcusHolly left a comment

Choose a reason for hiding this comment

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

LGTM - the second reviewer should provide a more technical review about what's stated in this documentation

@lbianchi-lbl lbianchi-lbl added the documentation Improvements or additions to documentation label Jun 27, 2024
Copy link
Contributor

@adam-a-a adam-a-a left a comment

Choose a reason for hiding this comment

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

LGTM - just that one change to throw the citation note at the top instead of bottom

@lbianchi-lbl lbianchi-lbl enabled auto-merge (squash) June 27, 2024 22:01
@lbianchi-lbl lbianchi-lbl merged commit b1a84b4 into watertap-org:main Jun 27, 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:High High Priority Issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants