Fixing broken links#1028
Conversation
rgsl888prabhu
added
doc
rgsl888prabhu
added
non-breaking
|
/ok to test abcad88 |
📝 WalkthroughWalkthroughUpdated documentation links across five files, replacing local file references and outdated GitHub URLs with current external dataset URLs and notebook paths. All changes involve hyperlink targets only; no content modifications or code logic alterations. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 Ruff (0.15.7)docs/cuopt/source/cuopt-python/routing/routing-example.ipynbUnexpected end of JSON input Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/cuopt/source/cuopt-c/lp-qp-milp/lp-qp-example.rst`:
- Line 94: The external download link for "sample.mps" in the sentence starting
with "A sample MPS file (:download:`download sample.mps ..." does not match the
locally-included example used later ("examples/sample.mps"); update the download
target so it points to the same literal file used by the documentation (replace
the raw GitHub URL with the repository path/version that corresponds to the
local examples/sample.mps or use a literalinclude/reference to the same
examples/sample.mps), ensuring the URL/target and the local example name
"sample.mps" are identical so the downloaded file and the documented output
remain consistent.
In `@docs/cuopt/source/cuopt-c/lp-qp-milp/milp-examples.rst`:
- Line 101: The docs currently reference an external download tag "download
mip_sample.mps
<https://raw.githubusercontent.com/coin-or/SYMPHONY/master/Datasets/sample.mps>"
while the text and expected output refer to the local file
examples/mip_sample.mps, causing a mismatch; update the download directive so it
points to the same file used by the examples (replace the external URL with the
repository-local examples/mip_sample.mps path) or alternatively change the
example references and expected output to match the external sample.mps
URL—ensure the token "mip_sample.mps" and all occurrences of
"examples/mip_sample.mps" and the download directive are made consistent.
In `@docs/cuopt/source/cuopt-server/examples/lp-examples.rst`:
- Line 410: The docs currently reference an external MPS URL in the
display/download text but use a local file name `sample.mps` in the subsequent
CLI and example commands, causing inconsistency; update the examples so the same
artifact is used everywhere—either change the download/display link to point to
the local `sample.mps` artifact or update the CLI/example commands to reference
the external URL—ensure all occurrences of `sample.mps`, the download link
(https://people.math.sc.edu/Burkardt/datasets/mps/testprob.mps), and any CLI
example lines use the identical artifact reference so displayed, downloaded, and
executed inputs are the same.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: ef84d9f9-f48c-4c5a-8336-2acc377f89ee
📒 Files selected for processing (5)
docs/cuopt/source/cuopt-c/lp-qp-milp/lp-qp-example.rstdocs/cuopt/source/cuopt-c/lp-qp-milp/milp-examples.rstdocs/cuopt/source/cuopt-python/routing/routing-example.ipynbdocs/cuopt/source/cuopt-server/examples/lp-examples.rstdocs/cuopt/source/faq.rst
| LIBCUOPT_LIBRARY_PATH=$(find / -name "libcuopt.so" 2>/dev/null) | ||
| A sample MPS file (:download:`download sample.mps <examples/sample.mps>`): | ||
| A sample MPS file (:download:`download sample.mps <https://raw.githubusercontent.com/BUGSENG/PPL/devel/demos/ppl_lpsol/examples/sample.mps>`): |
There was a problem hiding this comment.
Download target should match the literalincluded sample file.
At Line 94, the external sample.mps may differ from the local examples/sample.mps shown at Line 96 and used for the documented output, which can break the example flow.
Suggested fix
-A sample MPS file (:download:`download sample.mps <https://raw.githubusercontent.com/BUGSENG/PPL/devel/demos/ppl_lpsol/examples/sample.mps>`):
+A sample MPS file (:download:`download sample.mps <examples/sample.mps>`):As per coding guidelines: docs/**/*: “Accuracy: Verify code examples compile and run correctly” and “Consistency: Version numbers, parameter types, and terminology match code.”
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| A sample MPS file (:download:`download sample.mps <https://raw.githubusercontent.com/BUGSENG/PPL/devel/demos/ppl_lpsol/examples/sample.mps>`): | |
| A sample MPS file (:download:`download sample.mps <examples/sample.mps>`): |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/cuopt/source/cuopt-c/lp-qp-milp/lp-qp-example.rst` at line 94, The
external download link for "sample.mps" in the sentence starting with "A sample
MPS file (:download:`download sample.mps ..." does not match the
locally-included example used later ("examples/sample.mps"); update the download
target so it points to the same literal file used by the documentation (replace
the raw GitHub URL with the repository path/version that corresponds to the
local examples/sample.mps or use a literalinclude/reference to the same
examples/sample.mps), ensuring the URL/target and the local example name
"sample.mps" are identical so the downloaded file and the documented output
remain consistent.
| LIBCUOPT_LIBRARY_PATH=$(find / -name "libcuopt.so" 2>/dev/null) | ||
| A sample MILP MPS file (:download:`download mip_sample.mps <examples/mip_sample.mps>`): | ||
| A sample MILP MPS file (:download:`download mip_sample.mps <https://raw.githubusercontent.com/coin-or/SYMPHONY/master/Datasets/sample.mps>`): |
There was a problem hiding this comment.
Keep the downloadable MPS file aligned with the included sample.
Line 101 now downloads an external file, while Line 103 and the expected output still correspond to examples/mip_sample.mps. This can make the walkthrough non-reproducible for users.
Suggested fix
-A sample MILP MPS file (:download:`download mip_sample.mps <https://raw.githubusercontent.com/coin-or/SYMPHONY/master/Datasets/sample.mps>`):
+A sample MILP MPS file (:download:`download mip_sample.mps <examples/mip_sample.mps>`):As per coding guidelines: docs/**/*: “Accuracy: Verify code examples compile and run correctly” and “Consistency: Version numbers, parameter types, and terminology match code.”
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| A sample MILP MPS file (:download:`download mip_sample.mps <https://raw.githubusercontent.com/coin-or/SYMPHONY/master/Datasets/sample.mps>`): | |
| A sample MILP MPS file (:download:`download mip_sample.mps <examples/mip_sample.mps>`): |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/cuopt/source/cuopt-c/lp-qp-milp/milp-examples.rst` at line 101, The docs
currently reference an external download tag "download mip_sample.mps
<https://raw.githubusercontent.com/coin-or/SYMPHONY/master/Datasets/sample.mps>"
while the text and expected output refer to the local file
examples/mip_sample.mps, causing a mismatch; update the download directive so it
points to the same file used by the examples (replace the external URL with the
repository-local examples/mip_sample.mps path) or alternatively change the
example references and expected output to match the external sample.mps
URL—ensure the token "mip_sample.mps" and all occurrences of
"examples/mip_sample.mps" and the download directive are made consistent.
| Batch mode is not available for MILP problems. | ||
|
|
||
| A sample MPS file (:download:`sample.mps <lp/examples/sample.mps>`): | ||
| A sample MPS file (:download:`sample.mps <https://people.math.sc.edu/Burkardt/datasets/mps/testprob.mps>`): |
There was a problem hiding this comment.
Use the same MPS artifact for display, download, and CLI steps.
Line 410 points to an external dataset, but Line 412 and the example commands use local sample.mps. This introduces a docs mismatch and can produce different solver results than the documented response.
Suggested fix
-A sample MPS file (:download:`sample.mps <https://people.math.sc.edu/Burkardt/datasets/mps/testprob.mps>`):
+A sample MPS file (:download:`sample.mps <lp/examples/sample.mps>`):As per coding guidelines: docs/**/*: “Accuracy: Verify code examples compile and run correctly” and “Consistency: Version numbers, parameter types, and terminology match code.”
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| A sample MPS file (:download:`sample.mps <https://people.math.sc.edu/Burkardt/datasets/mps/testprob.mps>`): | |
| A sample MPS file (:download:`sample.mps <lp/examples/sample.mps>`): |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/cuopt/source/cuopt-server/examples/lp-examples.rst` at line 410, The
docs currently reference an external MPS URL in the display/download text but
use a local file name `sample.mps` in the subsequent CLI and example commands,
causing inconsistency; update the examples so the same artifact is used
everywhere—either change the download/display link to point to the local
`sample.mps` artifact or update the CLI/example commands to reference the
external URL—ensure all occurrences of `sample.mps`, the download link
(https://people.math.sc.edu/Burkardt/datasets/mps/testprob.mps), and any CLI
example lines use the identical artifact reference so displayed, downloaded, and
executed inputs are the same.
|
/merge |
3 participants
Repairing broken URLs in the docs
Description
Issue
Checklist