Repository navigation
docs: complete exported API documentation - #13
Merged
ajbeck merged 1 commit intoSep 27, 2026
Merged
Conversation
Give every authn, iamproof and authz sentinel its own doc comment, including the HTTP status that authn's Error carries. Add doc links for unambiguous identifier references across the public packages, name the VerifyFunc and CheckFunc parameters, and name Claim.Bool's results. Record decision 0026 as implemented.
ajbeck
added this pull request to stack #7
September 27, 2026 14:36
ajbeck
marked this pull request as ready for review
September 27, 2026 15:05
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.
Implements E6 and records decision 0026 as implemented.
authn,iamproofandauthzsentinel gets its own doc comment. Theauthnones state their HTTP status, checked against eachfailurecall site.Type.Methodand qualified module names. Single-word identifiers such asAnyorRequestare left unlinked so ordinary prose isn't linked by mistake.VerifyFuncandCheckFuncparameters are named, as areClaim.Bool's results.Part of decision 0026, approved by the owner; stacked on #12.
Validation
gofmt,
go vet ./...,go mod verify,go test -race ./...,sh scripts/check-consumer.sh, Linux arm64/amd64 builds andgit diff --checkall pass locally on Go 1.27.1.A go/doc-based check confirmed that every doc link in the six public packages resolves. Parameter and result names don't change type identity, so this is not breaking.