Skip to content

Make function param name match to help clangd and IDEs - #640

Merged
kostasrim merged 1 commit into
romange:masterfrom
abhijat:abhijat/fix/clangd-diagnostics
Aug 11, 2026
Merged

Make function param name match to help clangd and IDEs#640
kostasrim merged 1 commit into
romange:masterfrom
abhijat:abhijat/fix/clangd-diagnostics

Conversation

@abhijat

@abhijat abhijat commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Purely cosmetic change, helps certain IDEs depending partially on clangd (like CLion Nova). By matching the parameter name in declaration vs definition suppresses false positives on AwaitBrief throughout dragonfly

@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 67535885-f1f7-495d-827d-9e7f4ebb1913

📥 Commits

Reviewing files that changed from the base of the PR and between 0dda4d0 and 9d128ea.

📒 Files selected for processing (1)
  • util/fibers/proactor_base.h
🚧 Files skipped from review as they are similar to previous changes (1)
  • util/fibers/proactor_base.h

📝 Walkthrough

Walkthrough

ProactorBase::AwaitBrief now uses brief for its callable parameter throughout the implementation. Control flow and behavior remain unchanged.

Changes

AwaitBrief parameter rename

Layer / File(s) Summary
Rename callable parameter
util/fibers/proactor_base.h
Renames the parameter from f to brief across invocation, type deduction, forwarding, and lambda capture usage.

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the parameter-name alignment and its benefit for clangd and IDEs.
Description check ✅ Passed The description directly explains the cosmetic parameter-name change and its clangd-related purpose.
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.

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.

@augmentcode

augmentcode Bot commented Aug 11, 2026

Copy link
Copy Markdown
🤖 Augment PR Summary

Summary: This PR aligns the AwaitBrief implementation parameter name with its declaration.
Why: The consistent brief name removes clangd/IDE false positives while preserving the existing forwarding, invocation, and result-handling behavior.

🤖 Was this summary useful? React with 👍 or 👎

@augmentcode augmentcode Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Review completed. No suggestions at this time.

Comment augment review to trigger a new review at any time.

@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

Align AwaitBrief parameter name to reduce clangd/IDE false diagnostics

✨ Enhancement 🕐 Less than 5 minutes

Grey Divider

AI Description

• Rename AwaitBrief parameter to match declaration/definition for clangd-based IDEs
• Reduce false-positive diagnostics around AwaitBrief usage without changing behavior
Diagram

graph TD
  C["Caller thread"] --> A["ProactorBase::AwaitBrief"] --> D["DispatchBrief"] --> L["Lambda runs brief"] --> R["ResultMover + Done"]
Loading
High-Level Assessment

This is the most direct, lowest-risk fix: aligning the parameter identifier between declaration/definition avoids clangd/IDE confusion without affecting ABI or runtime behavior. Alternatives (e.g., suppressing diagnostics or changing tooling settings) are less reliable and harder to enforce across contributors.

Files changed (1) +5 / -5

Refactor (1) +5 / -5
proactor_base.hRename AwaitBrief parameter from f to brief for clangd friendliness +5/-5

Rename AwaitBrief parameter from f to brief for clangd friendliness

• Renames the AwaitBrief template parameter and all local uses from 'f' to 'brief', including decltype deduction and the lambda capture. No behavioral or control-flow changes; this is intended to suppress clangd-based false positives in IDEs.

util/fibers/proactor_base.h

@qodo-code-review

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can group findings by type and pick your Finding display, from Minimal to Full

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

Signed-off-by: Abhijat Malviya <abhijat@dragonflydb.io>
@abhijat
abhijat force-pushed the abhijat/fix/clangd-diagnostics branch from 0dda4d0 to 9d128ea Compare August 11, 2026 13:20

@glevkovich glevkovich left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@kostasrim
kostasrim merged commit 59686b4 into romange:master Aug 11, 2026
12 checks passed
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.

3 participants