Skip to content

Update docstring in src/model.jl #459

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

Merged
merged 4 commits into from
Jun 30, 2025

Conversation

arnavk23
Copy link
Contributor

@arnavk23 arnavk23 commented Jun 30, 2025

This PR adds documentation to clarify an important corner case when using multiple CUTEstModel instances.

This note helps users understand:

  • why conflicts can happen
  • when conflicts do not happen

No code change; documentation only.
Closes #440

@arnavk23
Copy link
Contributor Author

@amontoison Please review the changes made here.

@amontoison
Copy link
Member

I removed the last sentence because we don't provide (yet) a way to specify a custom "tag" when we create the CUTEstModel.

@amontoison amontoison merged commit 780dc56 into JuliaSmoothOptimizers:main Jun 30, 2025
15 of 16 checks passed
@arnavk23 arnavk23 deleted the new-feature-branch branch June 30, 2025 14:01
@amontoison
Copy link
Member

Thank you!
Another useful PR 💯

@arnavk23
Copy link
Contributor Author

Thank you @amontoison for the encouragement. I will keep working on more.

Copy link

codecov bot commented Jun 30, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.23%. Comparing base (f2ad6a4) to head (65e8e70).
Report is 154 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main     #459       +/-   ##
===========================================
- Coverage   89.11%   74.23%   -14.88%     
===========================================
  Files           5        7        +2     
  Lines         790     1669      +879     
===========================================
+ Hits          704     1239      +535     
- Misses         86      430      +344     

☔ 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.

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.

Coexistence of multiple CUTEst models
2 participants