docs: backfill exported docstrings to clear 80% coverage gate (closes #619)#880
docs: backfill exported docstrings to clear 80% coverage gate (closes #619)#880cristim wants to merge 2 commits into
Conversation
cristim
added
triaged
|
@coderabbitai review |
|
Warning Review limit reachedYou’ve reached a temporary PR review limit under our Fair Usage Limits Policy. Next review available in: 7 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the 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 configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (6)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
✅ Actions performedReview triggered.
|
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
|
@coderabbitai full review |
✅ Actions performedFull review triggered. |
|
@coderabbitai review |
✅ Action performedReview finished.
|
|
@coderabbitai full review |
✅ Action performedFull review finished. |
|
@coderabbitai review |
✅ Action performedReview finished.
|
|
@coderabbitai review |
✅ Action performedReview finished.
|
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.
1 participant
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), andproviders/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)