Skip to content

Refine docs for RCSP - #668

Open
andreacassioli wants to merge 1 commit into
boostorg:developfrom
andreacassioli:improve-docs-for-ResourceExtensionFunction-in-r_c_shortest_paths
Open

andreacassioli wants to merge 1 commit into
boostorg:developfrom
andreacassioli:improve-docs-for-ResourceExtensionFunction-in-r_c_shortest_paths

Conversation

@andreacassioli

@andreacassioli andreacassioli commented Oct 25, 2026 •

Copy link
Copy Markdown
Contributor

Important

New algorithms and API additions need a design issue first. Such a PR is not reviewed until an issue has settled the API and frozen the scope. PRs whose scope grows under review go stale. See How To Contribute an Algorithm.

Motivation

The documentation is not clear about how some of the input parameters of the extension function are used.

Discussed in #351

What this PR does

Add a couple of lines to give more details to the user.

Before submitting

  • I searched for an existing PR or issue covering the same change.
  • This PR targets the develop branch.
  • My contribution is licensed under the Boost Software License 1.0.

Kind of change

Tick exactly one. Each kind is reviewed differently, so mixing them in one PR makes the diff difficult to review (why).

  • Reformat (layout only, no token added or removed)
  • Refactor (no observable behavior change)
  • Behavior change (observable to users of the library)
  • No code change (documentation, build, CI, or tooling)

Change category

  • Bug fix
  • New algorithm or API addition
  • Deprecation or removal
  • Performance
  • Tests
  • Documentation
  • Build, CI, or tooling
  • Other (specify below)

@github-actions

Copy link
Copy Markdown

Boost dependency footprint vs develop (auto-generated).
PR run 40210629620 vs develop run 39949899700 (1fa81ebff2).

Header-inclusion weights (graph files pulling each direct dependency in):

No header-inclusion-weight changes.

Transitive Boost modules: 47 → 47 (0)

@cppalliance-bot

Copy link
Copy Markdown

An automated preview of the documentation is available at https://668.graph.prtest3.cppalliance.org/libs/graph/doc/html/index.html

If more commits are pushed to the pull request, the docs will rebuild at the same URL.

2026-10-25 16:17:51 UTC

@codecov

codecov Bot commented Oct 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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

@github-actions

Copy link
Copy Markdown

Compiler-warning counts vs develop (auto-generated).
PR run 40210629645 vs develop run 39949899676 (1fa81ebff2).

Job Baseline After Delta
macos (clang, 14) 256 256 0
macos (clang, 17) 255 255 0
macos (clang, 20) 255 255 0
ubuntu (clang-19, 14) 256 256 0
ubuntu (clang-19, 17) 255 255 0
ubuntu (clang-19, 20) 255 255 0
ubuntu (clang-19, 23) 255 255 0
ubuntu (gcc-14, 14) 352 352 0
ubuntu (gcc-14, 17) 348 348 0
ubuntu (gcc-14, 20) 348 348 0
ubuntu (gcc-14, 23) 348 348 0
windows_msvc_14_3 (msvc-14.3) 961 961 0

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.

2 participants