update doc for usage of incumbent utility function

[Iroy30]

Description

Issue

Closes #932

Checklist

• I am familiar with the Contributing Guidelines.
• Testing
  • New or existing tests cover these changes
  • Added tests
  • Created an issue to follow-up
  • NA
• Documentation
  • The documentation is up to date with these changes
  • Added new documentation
  • NA

[copy-pr-bot]

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation enhancement to the getIncumbentValues method in the linear programming problem module. The docstring is expanded to describe the method's utility for extracting incumbent values during callbacks and documents its parameters, with no functional code changes.

Changes

Cohort / File(s)	Summary
Documentation Enhancement python/cuopt/cuopt/linear_programming/problem.py	Expanded docstring for getIncumbentValues method to describe its purpose and document the solution and vars parameters. Function implementation remains unchanged.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the main change: updating documentation for the incumbent utility function.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Description check	✅ Passed	The PR description is minimal but directly related to the changeset, which updates documentation for the incumbent utility function.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (1)

python/cuopt/cuopt/linear_programming/problem.py (1)

1704-1720: LGTM! Documentation improvement is clear and helpful.

The expanded docstring properly describes the method's purpose and parameters for the incumbent callback use case.

One optional enhancement: consider adding a Returns section to document the return type (List[float]) for completeness.

📝 Optional: Add Returns section

         vars : List[:py:class:`Variable`]
             List of variables to extract corresponding incumbent values.
+
+        Returns
+        -------
+        List[float]
+            List of incumbent values corresponding to the given variables.
         """

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@python/cuopt/cuopt/linear_programming/problem.py` around lines 1704 - 1720,
Add a Returns section to the getIncumbentValues docstring that documents the
return type and contents (List[float] of incumbent values corresponding to the
input vars). Update the docstring for the function getIncumbentValues to include
a "Returns" heading describing that the function returns a list of floats (one
value per variable in vars) and any brief detail about ordering or length
matching vars.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@python/cuopt/cuopt/linear_programming/problem.py`:
- Around line 1704-1720: Add a Returns section to the getIncumbentValues
docstring that documents the return type and contents (List[float] of incumbent
values corresponding to the input vars). Update the docstring for the function
getIncumbentValues to include a "Returns" heading describing that the function
returns a list of floats (one value per variable in vars) and any brief detail
about ordering or length matching vars.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 6486bf37-ef1e-44fb-be8d-0782be892a49

📥 Commits

Reviewing files that changed from the base of the PR and between 2b21118 and 15e43e6.

📒 Files selected for processing (1)

• python/cuopt/cuopt/linear_programming/problem.py

[rgsl888prabhu]

@Iroy30 Also lets add this usage in one of the documentation example to showcase the usage.