Skip to content

Harmonic centrality docs#477

Merged
GomezGab merged 3 commits into
mainfrom
harmonic-centrality
May 12, 2026
Merged

Harmonic centrality docs#477
GomezGab merged 3 commits into
mainfrom
harmonic-centrality

Conversation

@GomezGab
Copy link
Copy Markdown
Collaborator

@GomezGab GomezGab commented May 12, 2026

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Harmonic Centrality documentation: definition, behavior on disconnected graphs, usage notes, Cypher procedure syntax, returned fields, worked examples, and a navigation entry linking to the new doc.
  • Chores
    • Added "HarmonicCentrality" to the project wordlist and normalized term capitalization across the wordlist.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 12, 2026

Warning

Rate limit exceeded

@GomezGab has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 25 minutes and 40 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a7d3bd59-15dd-4827-88e0-2a4265e9e10a

📥 Commits

Reviewing files that changed from the base of the PR and between 52af734 and d10a018.

📒 Files selected for processing (2)
  • .wordlist.txt
  • algorithms/harmonic-centrality.md
📝 Walkthrough

Walkthrough

This PR adds comprehensive documentation for the Harmonic Centrality graph algorithm, registers it in the algorithms index, and updates the project's .wordlist.txt with HarmonicCentrality and multiple capitalization/case ordering normalizations.

Changes

Harmonic Centrality Documentation

Layer / File(s) Summary
Harmonic Centrality Algorithm Documentation
algorithms/harmonic-centrality.md
Complete 152-line documentation file introducing Harmonic Centrality with formal definition (sum of inverse shortest-path distances, unreachable nodes contribute 0), comparison to closeness centrality on disconnected graphs, FalkorDB’s approximate HyperLogLog + GraphBLAS implementation, procedure syntax CALL algo.HarmonicCentrality([config]) with nodeLabels and relationshipTypes, yielded fields (node, score, optional reachable), two worked examples with expected result tables, and usage/performance notes.
Algorithm index entry
algorithms/index.md
Inserted a bullet link to ./harmonic-centrality.md under Pathfinding Algorithms with a short description noting robustness for disconnected graphs.
Wordlist capitalization normalization
.wordlist.txt
Inserted HarmonicCentrality and reordered many nearby capitalization/case variants across the file (multiple ranges updated to normalize relative placement of titlecase vs lowercase forms).

🎯 3 (Moderate) | ⏱️ ~20 minutes


🐰 I hopped through docs with nibbling cheer,
New centrality shines for graphs far and near,
Words tidied up in lists so bright,
Examples sparkle, procedures write,
A small brave change, now clear and dear.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title 'Harmonic centrality docs' directly reflects the main change: adding documentation for the Harmonic Centrality algorithm.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch harmonic-centrality

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@algorithms/harmonic-centrality.md`:
- Around line 26-28: The fenced code block containing the formula "H(u) = Σ(v ≠
u) 1 / d(u, v)" lacks a language identifier; update that triple-backtick block
to include an appropriate identifier (e.g., text or math) so the block is
properly rendered and linting passes while keeping the content of the H(u)
formula unchanged.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: ad2728c5-8b49-4a57-a54f-64f42642c6d8

📥 Commits

Reviewing files that changed from the base of the PR and between 5f90004 and aeacfdd.

📒 Files selected for processing (3)
  • .wordlist.txt
  • algorithms/harmonic-centrality.md
  • algorithms/index.md

Comment on lines +26 to +28
```
H(u) = Σ(v ≠ u) 1 / d(u, v)
```
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add language identifier to the fenced code block.

The fenced code block should specify a language identifier for proper rendering and to satisfy linting rules.

📝 Proposed fix
-```
+```text
 H(u) = Σ(v ≠ u) 1 / d(u, v)

</details>

<!-- suggestion_start -->

<details>
<summary>📝 Committable suggestion</summary>

> ‼️ **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.

```suggestion

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 26-26: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@algorithms/harmonic-centrality.md` around lines 26 - 28, The fenced code
block containing the formula "H(u) = Σ(v ≠ u) 1 / d(u, v)" lacks a language
identifier; update that triple-backtick block to include an appropriate
identifier (e.g., text or math) so the block is properly rendered and linting
passes while keeping the content of the H(u) formula unchanged.

@GomezGab GomezGab force-pushed the harmonic-centrality branch from 52af734 to d10a018 Compare May 12, 2026 16:02
@GomezGab GomezGab merged commit 3ce7b18 into main May 12, 2026
6 checks passed
@GomezGab GomezGab deleted the harmonic-centrality branch May 12, 2026 16:36
galshubeli added a commit that referenced this pull request May 13, 2026
Surfaced by a local dry-run against a historical commit pair: the
script was calling ``pathlib.Path(path).read_text()`` to grab the
content of added/modified files. That works in CI because
``actions/checkout`` puts HEAD on disk, but it fails locally when
the working directory isn't at HEAD_SHA (e.g., running the script
against a past commit to debug).

Switched to ``git show <head>:<path>``, which pulls the blob from
the object store regardless of what's checked out. Returns None on
"not present at that commit" and the caller skips silently — same
permissive behavior as the previous ``except FileNotFoundError: pass``
in the rename branch, now applied uniformly.

Verified locally on commit pair 5f90004..3ce7b18 (PR #477 merge):
script produces +1 ~1 -0 with correct file contents from the object
store. CI behavior unchanged because the checked-out HEAD's blobs
match the object-store blobs.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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