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

Fixing incorrect doc strings in control volume methods #820

Merged
merged 2 commits into from
Apr 22, 2022

Conversation

andrewlee94
Copy link
Member

Fixes #793

Summary/Motivation:

Control volume docs strings stated that custom_term argument should be a Pyomo Expression when in fact they should be Python methods which return Pyomo expressions.

Changes proposed in this PR:

  • Fix docs strings in CV0D and CV1D

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.

@andrewlee94 andrewlee94 requested review from Robbybp and eslickj April 21, 2022 20:23
@andrewlee94 andrewlee94 self-assigned this Apr 21, 2022
@andrewlee94 andrewlee94 added bug Something isn't working documentation Documentations comments and requests Priority:Normal Normal Priority Issue or PR core Issues dealing with core modeling components labels Apr 21, 2022
@blnicho blnicho changed the title Fixing incorrect doc stings in control volume methods Fixing incorrect doc strings in control volume methods Apr 21, 2022
Copy link
Member

@Robbybp Robbybp left a comment

Choose a reason for hiding this comment

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

Thanks for fixing, looks good.

@codecov
Copy link

codecov bot commented Apr 21, 2022

Codecov Report

Merging #820 (0de422c) into main (ebf51d2) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #820   +/-   ##
=======================================
  Coverage   67.91%   67.91%           
=======================================
  Files         567      567           
  Lines       62208    62208           
  Branches    11513    11513           
=======================================
+ Hits        42247    42251    +4     
  Misses      17784    17784           
+ Partials     2177     2173    -4     
Impacted Files Coverage Δ
idaes/core/base/control_volume0d.py 89.15% <ø> (ø)
idaes/core/base/control_volume1d.py 88.24% <ø> (ø)
idaes/ver.py 61.53% <0.00%> (-4.62%) ⬇️
idaes/dmf/util.py 54.04% <0.00%> (+1.27%) ⬆️
idaes/dmf/codesearch.py 100.00% <0.00%> (+1.44%) ⬆️
idaes/conftest.py 90.90% <0.00%> (+6.06%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ebf51d2...0de422c. Read the comment docs.

@andrewlee94 andrewlee94 enabled auto-merge (squash) April 22, 2022 15:43
@andrewlee94 andrewlee94 merged commit 828e469 into IDAES:main Apr 22, 2022
@andrewlee94 andrewlee94 deleted the issue_793 branch April 22, 2022 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working core Issues dealing with core modeling components documentation Documentations comments and requests Priority:Normal Normal Priority Issue or PR
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Error in docstring for custom_term in control_volume1d.py
3 participants