Repository navigation
Document the exported API - #90
Merged
Merged
Conversation
Every exported type, method and constant now has a doc comment, and the package has an overview: tokens, paths, errors, background operations and pages. Field comments in types.go are rewritten in English. Examples show up on pkg.go.dev; they compile but do not run, since they need a real token. The revive exported rule is on again, so new API cannot land undocumented.
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.
What
background operations, pages, configuration.
comments in types.go rewritten in English.
publishing, and following a background copy. They compile, but do
not run, since they need a real token.
comment. The stuttering check stays off: renaming DiskLogger and
friends would break callers.
No code changes.
Checked locally
go vet on amd64 and 386, go test ./..., golangci-lint v2.13.2 (and
that it fails when a doc comment is removed); every [Symbol] link in
the docs resolves.