Repository navigation
[docs]: Fix inaccurate and missing godoc comments - #210
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! 🚀 New features to boost your workflow:
|
pseudomuto
added this pull request to stack #212
October 7, 2026 16:45
A number of doc comments had drifted from the code they describe. Some named identifiers that no longer exist (rpc.Method, a CLI logger, perUpstream), many still described the per-upstream proxy and unix socket removed in #205, and a few stated the opposite of what the code does: GT/GTE/LT claimed NaN never passes when it always does, NamespacedVault.Open claimed to use its namespace, etc. This corrects those against the current code, fills in the doc comments flagged as missing, and documents caller-visible constraints that were only discoverable by reading the implementation, such as NewKEKRegistry rejecting duplicate key IDs and KeyConfig's bounds. It also drops a spec reference and the remaining em-dashes. Only comments change here.
pseudomuto
force-pushed
the
godoc-fixes
branch
from
October 7, 2026 17:19
eed7876 to
0244cfb
Compare
Vaughan-Temporal
approved these changes
Oct 7, 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
3 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.
Several doc comments have drifted from the code they describe. Some named identifiers no longer exist (rpc.Method, a CLI logger, perUpstream), many still described the per-upstream proxy and unix socket removed in #205, and a few stated the opposite of what the code does: GT/GTE/LT claimed NaN never passes when it always does, NamespacedVault.Open claimed to use its namespace, etc.
This corrects those against the current code, fills in the doc comments flagged as missing, and documents caller-visible constraints that were only discoverable by reading the implementation, such as NewKEKRegistry rejecting duplicate key IDs and KeyConfig's bounds.
Only comments change here.