Skip to content

chore(nvca): fix Deprecated doc comment formatting#230

Open
mesutoezdil wants to merge 2 commits into
NVIDIA:mainfrom
mesutoezdil:mesutoezdil/chore/nvca-deprecated-comment
Open

chore(nvca): fix Deprecated doc comment formatting#230
mesutoezdil wants to merge 2 commits into
NVIDIA:mainfrom
mesutoezdil:mesutoezdil/chore/nvca-deprecated-comment

Conversation

@mesutoezdil

@mesutoezdil mesutoezdil commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Added the blank comment line gocritic (deprecatedComment) requires before a Deprecated: notice on SetMiniServiceReadyStatus.

Tested: one-line change, no behavior affected.

Refs: NO-REF

gocritic flagged the Deprecated notice on SetMiniServiceReadyStatus
for not being in its own paragraph. Without the blank comment line,
go vet and IDE tooling do not reliably recognize it as a deprecation
notice, so callers would not get flagged.

NO-REF

Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
@mesutoezdil
mesutoezdil requested a review from a team as a code owner July 17, 2026 07:34
@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

A standalone comment separator was inserted between two mini-service metric sections in the NVCA metrics source. No logic, control flow, declarations, or metric behavior changed.

Changes

Metrics formatting

Layer / File(s) Summary
Comment separator
src/compute-plane-services/nvca/internal/metrics/metrics.go
Adds a standalone // line between the mini-service failure and readiness sections.

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the PR's doc comment formatting fix for the deprecated method.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

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