docs(spanner): add missing documentation#5784
Merged
Merged
Conversation
Adds missing documentation for public methods and types. The documentation for the module exports is a stop-gap to be able to remove the allow(missing_docs) annotation. The module exports need a general audit, but this ensures that we can remove the annotation and prevent further slippage in missing documentation. Fixes googleapis#5537
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request removes the #![allow(missing_docs)] attribute and adds comprehensive documentation comments across various modules, structs, enums, and traits in the Spanner crate. It also encapsulates fields in MutationGroup and Statement by making them private or crate-private and exposing public getter methods. The review feedback suggests removing several redundant TODO(#5430) comments that reference already-tracked issues to keep the codebase clean.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #5784 +/- ##
==========================================
- Coverage 97.88% 97.87% -0.02%
==========================================
Files 226 226
Lines 56465 56471 +6
==========================================
- Hits 55273 55272 -1
- Misses 1192 1199 +7 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
olavloite
force-pushed
the
spanner-add-missing-docs
branch
from
e662061 to
5285a7a
Compare
alvarowolfx
approved these changes
May 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds missing documentation for public methods and types.
The documentation for the module exports is a stop-gap to be able to remove the
allow(missing_docs) annotation. The module exports need a general audit, but this
ensures that we can remove the annotation and prevent further slippage in missing
documentation.
Fixes #5537