ilyabrin / disk

78%

release: 78%

LAST BUILD ON BRANCH docs/api-comments

branch: docs/api-comments

CHANGE BRANCH

x

Reset

• docs/api-comments
• additions-in-types
• alert-autofix-1
• alert-autofix-2
• chore/gitattributes
• ci/lint-v2
• ci/main-branch
• dependabot/github_actions/actions/checkout-4
• dependabot/github_actions/actions/setup-go-4
• dependabot/github_actions/actions/setup-go-5
• dependabot/github_actions/coverallsapp/github-action-1.2.0
• dependabot/github_actions/coverallsapp/github-action-1.2.4
• dependabot/github_actions/coverallsapp/github-action-2.0.0
• dependabot/github_actions/coverallsapp/github-action-2.1.0
• dependabot/github_actions/coverallsapp/github-action-2.1.2
• dependabot/github_actions/coverallsapp/github-action-2.2.0
• dependabot/github_actions/coverallsapp/github-action-2.2.1
• dependabot/github_actions/coverallsapp/github-action-2.2.3
• dependabot/github_actions/coverallsapp/github-action-2.3.0
• dependabot/github_actions/coverallsapp/github-action-2.3.3
• dependabot/github_actions/dot-github/workflows/actions/checkout-5
• dependabot/github_actions/dot-github/workflows/actions/checkout-6
• dependabot/github_actions/dot-github/workflows/actions/checkout-7
• dependabot/github_actions/dot-github/workflows/actions/dependency-review-action-5
• dependabot/github_actions/dot-github/workflows/actions/setup-go-6
• dependabot/github_actions/dot-github/workflows/actions/setup-go-7
• dependabot/github_actions/dot-github/workflows/coverallsapp/github-action-2.3.6
• dependabot/github_actions/dot-github/workflows/coverallsapp/github-action-2.3.7
• dependabot/github_actions/dot-github/workflows/coverallsapp/github-action-2.3.8
• dependabot/github_actions/dot-github/workflows/github/codeql-action-4
• dependabot/github_actions/dot-github/workflows/securego/gosec-2.22.10
• dependabot/github_actions/dot-github/workflows/securego/gosec-2.22.11
• dependabot/github_actions/dot-github/workflows/securego/gosec-2.22.7
• dependabot/github_actions/dot-github/workflows/securego/gosec-2.22.8
• dependabot/github_actions/dot-github/workflows/securego/gosec-2.22.9
• dependabot/github_actions/dot-github/workflows/securego/gosec-2.23.0
• dependabot/github_actions/dot-github/workflows/securego/gosec-2.27.1
• dependabot/github_actions/dot-github/workflows/securego/gosec-2.28.0
• dependabot/github_actions/github-actions-38f1f72cae
• dependabot/github_actions/github-actions-541e0c332b
• dependabot/github_actions/github/codeql-action-3
• dependabot/github_actions/jandelgado/gcov2lcov-action-1.1.0
• dependabot/github_actions/jandelgado/gcov2lcov-action-1.1.1
• dependabot/go_modules/github.com/stretchr/testify-1.10.0
• dependabot/go_modules/github.com/stretchr/testify-1.11.0
• dependabot/go_modules/github.com/stretchr/testify-1.11.1
• dependabot/go_modules/github.com/stretchr/testify-1.9.0
• dependabot/go_modules/go-dependencies-37ff05d3c1
• dependabot/go_modules/gopkg.in/dnaeon/go-vcr.v3-3.2.0
• disk-rc1
• docs/changelog
• docs/community
• docs/friendly
• feat/api-coverage
• feat/public-settings
• feature/comprehensive-improvements
• fix/api-params
• fix/delete-status
• fix/int64-sizes
• fix/log-request
• fix/security-alerts
• fix/transfer-timeouts
• fix/trash-listing
• lil-fix-readme
• main
• new-version
• refs/tags/v1.0.1
• release
• security-checks
• tests
• tests-1
• tmp-push-probe
• update-readme
• v1.1.0
• v1.1.1
• v1.2.0
• v1.2.1
• v1.2.2
• v1.2.3
• v1.3.0
• v1.4.0
• v1.5.0

Build # 37688469120

Build Type

Pull #90

github

Committed by ilyabrin

Commit Message

docs: document the whole exported API

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.

Pull Request Pull Request #90: Document the exported API

Coverage Stats

1926 of 2461 relevant lines covered (78.26%)

19.71 hits per line