Skip to content

Conversation

@A-CGray
Copy link
Member

@A-CGray A-CGray commented Oct 8, 2025

Purpose

Was reading the docstring of addConGroup and found a couple of mistakes and missing pieces of information so I fixed them. I also added a warning that will be raised when a constraint has neither upper nor lower bounds defined.

Expected time until merged

no rush

Type of change

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

Testing

Checklist

  • I have run ruff check and ruff format to make sure the Python code adheres to PEP-8 and is consistently formatted
  • I have formatted the Fortran code with fprettify or C/C++ code with clang-format as applicable
  • I have run unit and regression tests which pass locally with my changes
  • I have added new tests that prove my fix is effective or that my feature works
  • I have added necessary documentation

@A-CGray A-CGray requested a review from a team as a code owner October 8, 2025 17:35
@A-CGray A-CGray requested review from Copilot, kanekosh and sanjan98 and removed request for kanekosh and sanjan98 October 8, 2025 17:35
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR improves the addConGroup function documentation and adds a validation warning. It fixes docstring errors and clarifies parameter descriptions, while also adding a runtime warning for constraints that have neither upper nor lower bounds defined.

  • Fixed docstring description to reference constraints instead of variables
  • Updated parameter documentation to clarify optional nature and default behaviors
  • Added warning validation for constraints without bounds

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@A-CGray A-CGray requested review from kanekosh and sanjan98 October 8, 2025 17:36
@codecov
Copy link

codecov bot commented Oct 8, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.27%. Comparing base (8554985) to head (1e5f1fb).
⚠️ Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #463      +/-   ##
==========================================
+ Coverage   86.26%   86.27%   +0.01%     
==========================================
  Files          24       24              
  Lines        3429     3432       +3     
==========================================
+ Hits         2958     2961       +3     
  Misses        471      471              

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

ewu63
ewu63 previously approved these changes Oct 8, 2025
specifies for what dvs have non-zero Jacobian values
for this set of constraints. The order is not important.
wrt : iterable (list, set, OrderedDict, array etc), optional
'wrt' stands for 'With Respect To'. This specifies which dvs this constraint is assumed to depend on, and
Copy link
Collaborator

Choose a reason for hiding this comment

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

This can be expanded upon by explaining that it needs to be an iterable of str which specifies the DVGroups which are sensitive to.

@A-CGray A-CGray requested a review from ewu63 October 9, 2025 15:27
@ewu63 ewu63 merged commit bee4701 into main Oct 9, 2025
18 of 19 checks passed
@A-CGray A-CGray deleted the docFix branch October 10, 2025 01:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants