fix: correct README examples and add missing godoc#4
Merged
Conversation
Two README examples used 'return nil, fault' with a single-error return type. Add missing doc comment on WithUnimplemented to match all other With* functions.
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
1 participant
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.
Summary
return nil, faults.Unauthenticated/return nil, faults.PermissionDeniedinside functions with a singleerrorreturn type — these would not compileWithUnimplemented, the onlyWith*function without oneNote
Low Risk
Low risk documentation-only change: fixes two non-compiling README snippets and adds a missing GoDoc comment, with no runtime behavior changes.
Overview
Fixes the README
AuthenticationandPermissionexamples to return a singleerror(removing the invalidreturn nil, ...pattern).Adds the missing GoDoc comment for
WithUnimplementedto match the otherWith*helpers.Written by Cursor Bugbot for commit 91abab7. This will update automatically on new commits. Configure here.