Skip to content

(sql) betweennessCentrality: fix documentation link in function comment - #3175

Open
xaemonn wants to merge 1 commit into
pgRouting:developfrom
xaemonn:doc-link-betweenness
Open

xaemonn wants to merge 1 commit into
pgRouting:developfrom
xaemonn:doc-link-betweenness

Conversation

@xaemonn

@xaemonn xaemonn commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Changes proposed in this PR:

  • The comment on pgr_betweennessCentrality links to pgr_centrality.html, which does
    not exist (404). The documentation page is pgr_betweennessCentrality.html.
  • This changes the page name in sql/metrics/betweennessCentrality.sql.

Tested: built and installed, created the extension in a new database;
obj_description() now shows .../pgr_betweennessCentrality.html.

CI on my fork:
https://github.com/xaemonn/pgrouting/actions?query=branch%3Adoc-link-betweenness

@pgRouting/admins

Summary by CodeRabbit

  • Documentation
    • Corrected the linked reference for betweenness centrality.

@coderabbitai

coderabbitai Bot commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Repository UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 80a258c6-c7f0-488d-8ef1-0dd74b0ffc18
Commits

Reviewing files that changed from the base of the PR and between 09066f6 and ea5c10b.

Files selected for processing: 1
  • sql/metrics/betweennessCentrality.sql

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Walkthrough

The function comment now links to pgr_betweennessCentrality.html instead of pgr_centrality.html. The function signature and behavior did not change.

Changes

Betweenness centrality documentation

Layer / File(s) Summary
Update documentation link
sql/metrics/betweennessCentrality.sql
The function comment now links to pgr_betweennessCentrality.html.

Priority: Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other · Severity of issue fixed: Low

Merge Risk: Minimal · up to ea5c1

This documentation-only change is ready to merge.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly identifies the SQL function and the documentation-link fix. It accurately summarizes the only change in the pull request.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

A rabbit found a link astray,
And set it on the proper way.
To betweenness pages, bright,
The comment points just right.
Then hopped away beneath the moon.

Comment @coderabbitai help to get the list of available commands.

This branch has not been deployed

No deployments
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.

1 participant