-
Notifications
You must be signed in to change notification settings - Fork 551
Clean pyomo collections module #3708
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
Conversation
31d0613
to
1d92091
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can merge this, but it would be good to add a bit of documentation while we are refactoring.
pyomo/common/collections/_hasher.py
Outdated
from collections import defaultdict | ||
|
||
|
||
class _Hasher(defaultdict): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We talked about this on the dev call, but I think it would be worth removing the _
-- Sphinx by default will not document private classes, attributes, etc.
Of course, we should also add documentation to this class...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks John for the review. I added a short documentation of the class. I let you tell me if it is clear enough.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3708 +/- ##
=======================================
Coverage 89.19% 89.19%
=======================================
Files 892 893 +1
Lines 103100 103099 -1
=======================================
Hits 91956 91956
+ Misses 11144 11143 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Some minor wording changes (the only real reason for the change is to line wrap, and to us the Sphinx "magic comment" syntax)
Co-authored-by: John Siirola <[email protected]>
Co-authored-by: John Siirola <[email protected]>
Fixes NA
Summary/Motivation:
This PR introduce some refactoring of the pyomo collections module.
Changes proposed in this PR:
OrderDict
import fromorderset
.Legal Acknowledgement
By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution: