docs: backfill exported docstrings to clear 80% coverage gate (closes #619) by cristim · Pull Request #880 · LeanerCloud/cloud-commitments-cli

cristim · 2026-05-30T18:34:29Z

Closes #619

Summary

Backfills Go doc comments on the 16 exported identifiers (across 7 files) that were left undocumented, lifting measured exported-identifier coverage from ~60% to 100%.

Packages touched: internal/api (7 auth/session types), ci_cd_sanity_tests/pkg/sanity/{aws,azure,report} (sanity-test types + package-level docs), cmd/lambda/clear-rate-limit (Lambda response type), ci_cd_sanity_tests/cmd/ri-exchange (CLI output type), and providers/azure/services/compute (retail price envelope).

All comments explain purpose and context rather than restating the identifier name. No logic changes; only // ... lines were added.

Test plan

go build ./... passes (verified locally)
go vet ./... passes (verified locally)
CodeRabbit docstring-coverage check passes (>= 80%)

Summary by CodeRabbit

Documentation
- Improved developer-facing documentation across AWS sanity checks, reporting, API types, Azure pricing responses, and rate-limit cleanup results.
- Clarified report status semantics, JSON output behavior, pagination indicators, and serialized execution results.
- Added descriptions for key request, response, and data types to improve generated documentation.

cristim · 2026-05-30T18:34:36Z

@coderabbitai review

coderabbitai · 2026-05-30T18:34:38Z

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 57 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8fa8a17c-43fd-487a-8fce-4f20777f478d

📥 Commits

Reviewing files that changed from the base of the PR and between c4ec627 and c79cdba.

📒 Files selected for processing (5)

ci_cd_sanity_tests/cmd/ri-exchange/main.go
ci_cd_sanity_tests/pkg/sanity/aws/aws.go
ci_cd_sanity_tests/pkg/sanity/report/report.go
cmd/lambda/clear-rate-limit/main.go
internal/api/types.go

📝 Walkthrough

Walkthrough

Added Go documentation comments for CI sanity-test packages, API DTOs, a Lambda response type, and the Azure Retail Prices response envelope. No exported signatures, data structures, control flow, or runtime behavior changed.

Changes

Go documentation coverage

Layer / File(s)	Summary
Sanity test contracts and execution documentation `ci_cd_sanity_tests/...`	Documents sanity-test outputs, AWS options and execution behavior, and report types and methods.
API and Lambda response documentation `internal/api/types.go`, `cmd/lambda/clear-rate-limit/main.go`	Documents authentication DTOs, user and session records, and the Lambda response payload.
Azure pricing response documentation `providers/azure/services/compute/client.go`	Documents the paginated Azure Retail Prices response envelope and next-page indicator.

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

Possibly related PRs

LeanerCloud/CUDly#1364: Modifies the same Output struct area in the CI exchange command.

🚥 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 title clearly describes the docstring backfill and links it to the coverage gate and issue `#619`.
Linked Issues check	✅ Passed	The PR adds Go doc comments to the missing exported identifiers and matches the goal of raising docstring coverage above 80%.
Out of Scope Changes check	✅ Passed	The changes stay within documentation cleanup for the targeted packages and do not introduce unrelated logic or scope.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch fix/619-wave20

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

coderabbitai · 2026-05-30T18:34:40Z

✅ Actions performed

Review triggered.

cristim · 2026-05-30T19:03:33Z

@coderabbitai review

coderabbitai · 2026-05-30T19:03:38Z

✅ Actions performed

Review triggered.

cristim · 2026-05-30T19:37:53Z

@coderabbitai review

coderabbitai · 2026-05-30T19:37:57Z

✅ Actions performed

Review triggered.

cristim · 2026-05-30T19:49:32Z

@coderabbitai full review

coderabbitai · 2026-05-30T19:49:37Z

✅ Actions performed

Full review triggered.

cristim · 2026-06-04T14:03:01Z

@coderabbitai review

coderabbitai · 2026-06-04T14:03:08Z

✅ Action performed

Review finished.

cristim · 2026-06-08T09:31:25Z

@coderabbitai full review

coderabbitai · 2026-06-08T09:31:30Z

✅ Action performed

Full review finished.

cristim · 2026-06-19T21:44:55Z

@coderabbitai review

coderabbitai · 2026-06-19T21:45:13Z

✅ Action performed

Review finished.

cristim · 2026-07-10T15:47:11Z

@coderabbitai review

coderabbitai · 2026-07-10T15:47:18Z

✅ Action performed

Review finished.

cristim · 2026-07-19T18:15:06Z

@coderabbitai review

coderabbitai · 2026-07-19T18:15:13Z

✅ Action performed

Review finished.

coderabbitai

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 `@ci_cd_sanity_tests/pkg/sanity/report/report.go`:
- Around line 58-59: Clarify the WriteJSON comment to state that 0600
permissions apply only when the file is created, or update WriteJSON to
explicitly chmod the file after writing if every artifact must be 0600. Keep the
existing indented JSON serialization and upload behavior 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: 62ed0691-57f5-475c-907c-6892dbcd9d8b

📥 Commits

Reviewing files that changed from the base of the PR and between 5c267c5 and c4ec627.

📒 Files selected for processing (6)

ci_cd_sanity_tests/cmd/ri-exchange/main.go
ci_cd_sanity_tests/pkg/sanity/aws/aws.go
ci_cd_sanity_tests/pkg/sanity/report/report.go
cmd/lambda/clear-rate-limit/main.go
internal/api/types.go
providers/azure/services/compute/client.go

Add Go doc comments to all remaining undocumented exported identifiers across 7 files. Packages touched: internal/api (auth/session types), ci_cd_sanity_tests/pkg/sanity/{aws,azure,report} (sanity test types and package-level docs), cmd/lambda/clear-rate-limit (Lambda response type), ci_cd_sanity_tests/cmd/ri-exchange (CLI output type), and providers/azure/services/compute (retail price envelope). All comments explain purpose and context, not just the identifier name. Coverage moves from 60% to 100% on exported identifiers.

Three small follow-up tweaks to the docstring backfill: - clear-rate-limit/main.go: Response.RemainingCount counts ALL rate-limit rows, not only forgot_password rows; reword the doc to match. - internal/api/types.go: replace the colloquial "extends UserInfo" wording on User with an explicit field-level description and a callout that User is reserved for admin endpoints (LoginResponse/CurrentUserResponse use UserInfo / its own type). - ci_cd_sanity_tests/pkg/sanity/report: document the exported Add, HasFailures, and WriteJSON methods; Add notes the not-safe-for-concurrent use contract that current callers rely on.

Replace British-English variants (serialised, artefact, summarising) with the US-English spellings the misspell linter requires.

cristim · 2026-07-19T18:18:11Z

@coderabbitai review

coderabbitai · 2026-07-19T18:18:27Z

✅ Action performed

Review finished.

cristim · 2026-07-19T18:23:06Z

@coderabbitai review

coderabbitai · 2026-07-19T18:23:15Z

✅ Action performed

Review finished.

cristim · 2026-07-19T20:38:40Z

@coderabbitai review

coderabbitai · 2026-07-19T20:38:51Z

✅ Action performed

Review finished.

cristim added triaged Item has been triaged priority/p3 Polish / idea / may never ship severity/low Minor harm urgency/eventually No deadline impact/internal Team-internal only effort/m Days type/docs Documentation labels May 30, 2026

cristim changed the base branch from feat/multicloud-web-frontend to main June 9, 2026 15:43

cristim force-pushed the fix/619-wave20 branch from 4d5677c to a87cc83 Compare June 19, 2026 21:44

cristim force-pushed the fix/619-wave20 branch from a87cc83 to 596dc4a Compare July 10, 2026 15:46

cristim force-pushed the fix/619-wave20 branch 2 times, most recently from dc264a9 to c4ec627 Compare July 19, 2026 18:11

coderabbitai Bot reviewed Jul 19, 2026

View reviewed changes

Comment thread ci_cd_sanity_tests/pkg/sanity/report/report.go Outdated

cristim added 3 commits July 19, 2026 20:17

fix(lint): US-English spelling in ci_cd_sanity_tests docstrings

4d96b52

Replace British-English variants (serialised, artefact, summarising) with the US-English spellings the misspell linter requires.

cristim force-pushed the fix/619-wave20 branch from c4ec627 to 4d96b52 Compare July 19, 2026 18:18

docs(sanity): clarify report file creation mode

c79cdba

cristim merged commit 56e1bee into main Jul 21, 2026
19 checks passed

cristim deleted the fix/619-wave20 branch July 27, 2026 11:09

Conversation

cristim commented May 30, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Summary by CodeRabbit

Uh oh!

cristim commented May 30, 2026

Uh oh!

coderabbitai Bot commented May 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review limit reached

Walkthrough

Changes

Uh oh!

coderabbitai Bot commented May 30, 2026

Uh oh!

cristim commented May 30, 2026

Uh oh!

coderabbitai Bot commented May 30, 2026

Uh oh!

cristim commented May 30, 2026

Uh oh!

coderabbitai Bot commented May 30, 2026

Uh oh!

cristim commented May 30, 2026

Uh oh!

coderabbitai Bot commented May 30, 2026

Uh oh!

cristim commented Jun 4, 2026

Uh oh!

coderabbitai Bot commented Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cristim commented Jun 8, 2026

Uh oh!

coderabbitai Bot commented Jun 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cristim commented Jun 19, 2026

Uh oh!

coderabbitai Bot commented Jun 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cristim commented Jul 10, 2026

Uh oh!

coderabbitai Bot commented Jul 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cristim commented Jul 19, 2026

Uh oh!

coderabbitai Bot commented Jul 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cristim commented Jul 19, 2026

Uh oh!

coderabbitai Bot commented Jul 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cristim commented Jul 19, 2026

Uh oh!

coderabbitai Bot commented Jul 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cristim commented Jul 19, 2026

Uh oh!

coderabbitai Bot commented Jul 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

cristim commented May 30, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented May 30, 2026 •

edited

Loading

coderabbitai Bot commented Jun 4, 2026 •

edited

Loading

coderabbitai Bot commented Jun 8, 2026 •

edited

Loading

coderabbitai Bot commented Jun 19, 2026 •

edited

Loading

coderabbitai Bot commented Jul 10, 2026 •

edited

Loading

coderabbitai Bot commented Jul 19, 2026 •

edited

Loading

coderabbitai Bot commented Jul 19, 2026 •

edited

Loading

coderabbitai Bot commented Jul 19, 2026 •

edited

Loading

coderabbitai Bot commented Jul 19, 2026 •

edited

Loading