Enable godoclint linter with require-doc rule by BagToad · Pull Request #12841 · cli/cli

BagToad · 2026-03-04T23:19:49Z

Summary

Enable the godoclint linter with the require-doc rule to enforce that all exported symbols have godoc comments. This improves documentation coverage across the codebase.

Changes

Linter configuration

Add godoclint to the enabled linters in .golangci.yml
Configure with default: none and only the require-doc rule enabled
Exclude test files from the check

Godoc comments

Add documentation comments to 1857 exported symbols across the entire codebase, organized by package:

Package	Symbols
`api/`	236
`pkg/cmd/pr`	194
`pkg/cmd/attestation`	110
`pkg/cmd/repo`	106
`pkg/cmd/run`	100
`pkg/cmd/project`	91
`pkg/iostreams`	80
`pkg/cmd/extension`	64
`git/`	54
Other packages	822

Verification

golangci-lint run ./... passes with 0 issues
go build ./... succeeds

Potential unexport candidates (458 symbols)

The following exported symbols appear to only be referenced within their own package (based on a grep-based analysis). These could potentially be unexported in a follow-up to reduce the public API surface.

Note: This analysis may have false negatives — symbols used via reflection, interface satisfaction, or embedded struct field access may appear here despite being needed externally.

`api/`

File	Line	Symbol
`api/client.go`	196	`GenerateScopeErrorForGQL`
`api/queries_issue.go`	11	`IssuesPayload`
`api/queries_issue.go`	188	`ProjectV2ItemProject`
`api/queries_issue.go`	193	`ProjectV2ItemStatus`
`api/queries_issue.go`	221	`IssuesDisabledError`
`api/queries_issue.go`	252	`CommentAuthor`
`api/queries_pr.go`	22	`PullRequestMergeable`
`api/queries_pr.go`	105	`StatusCheckRollupNode`
`api/queries_pr.go`	109	`StatusCheckRollupCommit`
`api/queries_pr.go`	113	`CommitStatusCheckRollup`
`api/queries_pr.go`	141	`CheckRunStateActionRequired`
`api/queries_pr.go`	142	`CheckRunStateCancelled`
`api/queries_pr.go`	143	`CheckRunStateCompleted`
`api/queries_pr.go`	144	`CheckRunStateFailure`
`api/queries_pr.go`	145	`CheckRunStateInProgress`
`api/queries_pr.go`	146	`CheckRunStateNeutral`
`api/queries_pr.go`	147	`CheckRunStatePending`
`api/queries_pr.go`	148	`CheckRunStateQueued`
`api/queries_pr.go`	149	`CheckRunStateSkipped`
`api/queries_pr.go`	150	`CheckRunStateStale`
`api/queries_pr.go`	151	`CheckRunStateStartupFailure`
`api/queries_pr.go`	152	`CheckRunStateSuccess`
`api/queries_pr.go`	153	`CheckRunStateTimedOut`
`api/queries_pr.go`	154	`CheckRunStateWaiting`
`api/queries_pr.go`	157	`CheckRunCountByState`
`api/queries_pr.go`	166	`StatusStateError`
`api/queries_pr.go`	167	`StatusStateExpected`
`api/queries_pr.go`	168	`StatusStateFailure`
`api/queries_pr.go`	169	`StatusStatePending`
`api/queries_pr.go`	170	`StatusStateSuccess`
`api/queries_pr.go`	173	`StatusContextCountByState`
`api/queries_pr.go`	182	`CheckStatusStateCompleted`
`api/queries_pr.go`	183	`CheckStatusStateInProgress`
`api/queries_pr.go`	184	`CheckStatusStatePending`
`api/queries_pr.go`	185	`CheckStatusStateQueued`
`api/queries_pr.go`	186	`CheckStatusStateRequested`
`api/queries_pr.go`	187	`CheckStatusStateWaiting`
`api/queries_pr.go`	194	`CheckConclusionStateActionRequired`
`api/queries_pr.go`	195	`CheckConclusionStateCancelled`
`api/queries_pr.go`	196	`CheckConclusionStateFailure`
`api/queries_pr.go`	197	`CheckConclusionStateNeutral`
`api/queries_pr.go`	198	`CheckConclusionStateSkipped`
`api/queries_pr.go`	199	`CheckConclusionStateStale`
`api/queries_pr.go`	200	`CheckConclusionStateStartupFailure`
`api/queries_pr.go`	201	`CheckConclusionStateSuccess`
`api/queries_pr.go`	202	`CheckConclusionStateTimedOut`
`api/queries_pr.go`	278	`PullRequestCommit`
`api/queries_pr.go`	298	`PullRequestFile`
`api/queries_pr.go`	387	`PullRequestReviewStatus`
`api/queries_pr.go`	907	`NewReviewerUser`
`api/queries_pr.go`	920	`NewReviewerBot`
`api/queries_pr.go`	1242	`RefComparison`
`api/queries_pr_review.go`	32	`PullRequestReview`
`api/queries_repo.go`	167	`CodeOfConduct`
`api/queries_repo.go`	173	`RepositoryLicense`
`api/queries_repo.go`	179	`ContactLink`
`api/queries_repo.go`	185	`FundingLink`
`api/queries_repo.go`	190	`CodingLanguage`
`api/queries_repo.go`	194	`IssueTemplate`
`api/queries_repo.go`	201	`PullRequestTemplate`
`api/queries_repo.go`	206	`RepositoryTopic`
`api/queries_repo.go`	210	`RepositoryRelease`
`api/queries_repo.go`	217	`IssueLabel`
`api/queries_repo.go`	377	`CanPushToRepo`
`api/queries_repo.go`	1038	`RepoProject`
`api/queries_repo.go`	1090	`AssignableActor`
`api/queries_repo.go`	1105	`NewAssignableUser`
`api/queries_repo.go`	1135	`AssignableBot`
`api/queries_repo.go`	1140	`NewAssignableBot`
`api/queries_repo.go`	1284	`RepoLabel`
`api/query_builder.go`	208	`StatusCheckRollupGraphQLWithCountByState`
`api/reaction_groups.go`	38	`ReactionGroupUsers`

`git/`

File	Line	Symbol
`git/client.go`	448	`PushDefaultNothing`
`git/client.go`	449	`PushDefaultCurrent`
`git/client.go`	452	`PushDefaultSimple`
`git/client.go`	453	`PushDefaultMatching`
`git/client.go`	456	`ParsePushDefault`
`git/command.go`	95	`WithStdout`
`git/command.go`	101	`WithStdin`
`git/command.go`	107	`WithRepoDir`
`git/errors.go`	24	`GitError`
`git/objects.go`	42	`NewRemote`

`internal/codespaces/`

File	Line	Symbol
`internal/codespaces/api/api.go`	221	`CodespaceGitStatus`
`internal/codespaces/api/api.go`	229	`CodespaceMachine`
`internal/codespaces/connection/tunnels_api_server_mock.go`	43	`NewMockHttpClient`
`internal/codespaces/connection/tunnels_api_server_mock.go`	500	`SetDeadline`
`internal/codespaces/portforwarder/port_forwarder.go`	16	`InternalPortLabel`
`internal/codespaces/portforwarder/port_forwarder.go`	17	`UserForwardedPortLabel`
`internal/codespaces/portforwarder/port_forwarder.go`	21	`PrivatePortVisibility`
`internal/codespaces/portforwarder/port_forwarder.go`	22	`OrgPortVisibility`
`internal/codespaces/portforwarder/port_forwarder.go`	23	`PublicPortVisibility`
`internal/codespaces/portforwarder/port_forwarder.go`	38	`CodespacesPortForwarder`
`internal/codespaces/rpc/invoker.go`	26	`ConnectionTimeout`
`internal/codespaces/states.go`	26	`PostCreateStateSuccess`
`internal/codespaces/states.go`	27	`PostCreateStateFailed`

`internal/config/`

File	Line	Symbol
`internal/config/config.go`	581	`ConfigOption`
`internal/config/migration/multi_account.go`	15	`CowardlyRefusalError`
`internal/config/stub.go`	16	`NewBlankConfig`

`internal/featuredetection/`

File	Line	Symbol
`internal/featuredetection/detector_mock.go`	5	`DisabledDetectorMock`
`internal/featuredetection/detector_mock.go`	39	`EnabledDetectorMock`
`internal/featuredetection/detector_mock.go`	77	`AdvancedIssueSearchDetectorMock`
`internal/featuredetection/detector_mock.go`	86	`AdvancedIssueSearchUnsupported`
`internal/featuredetection/detector_mock.go`	92	`AdvancedIssueSearchSupportedAsOptIn`
`internal/featuredetection/detector_mock.go`	98	`AdvancedIssueSearchSupportedAsOnlyBackend`

`internal/keyring/`

File	Line	Symbol
`internal/keyring/keyring.go`	80	`MockInitWithError`

`internal/prompter/`

File	Line	Symbol
`internal/prompter/test.go`	12	`NewMockPrompter`
`internal/prompter/test.go`	25	`MockPrompter`
`internal/prompter/test.go`	110	`RegisterAuthToken`
`internal/prompter/test.go`	114	`RegisterConfirmDeletion`
`internal/prompter/test.go`	118	`RegisterInputHostname`
`internal/prompter/test.go`	122	`RegisterMarkdownEditor`
`internal/prompter/test.go`	146	`AssertOptions`
`internal/prompter/test.go`	150	`IndexFor`
`internal/prompter/test.go`	159	`IndexesFor`
`internal/prompter/test.go`	171	`NoSuchPromptErr`
`internal/prompter/test.go`	175	`NoSuchAnswerErr`

`internal/run/`

File	Line	Symbol
`internal/run/stub.go`	99	`CommandCallback`

`internal/tableprinter/`

File	Line	Symbol
`internal/tableprinter/table_printer.go`	38	`WithPadding`

`internal/text/`

File	Line	Symbol
`internal/text/text.go`	34	`DisplayWidth`

`internal/update/`

File	Line	Symbol
`internal/update/update.go`	31	`StateEntry`

`pkg/cmd/accessibility/`

File	Line	Symbol
`pkg/cmd/accessibility/accessibility.go`	18	`AccessibilityOptions`

`pkg/cmd/agent-task/`

File	Line	Symbol
`pkg/cmd/agent-task/capi/job.go`	37	`JobActor`
`pkg/cmd/agent-task/capi/job.go`	42	`JobPullRequest`
`pkg/cmd/agent-task/capi/job.go`	48	`JobError`
`pkg/cmd/agent-task/capi/sessions.go`	100	`SessionError`

`pkg/cmd/alias/`

File	Line	Symbol
`pkg/cmd/alias/imports/import.go`	17	`ImportOptions`

`pkg/cmd/api/`

File	Line	Symbol
`pkg/cmd/api/api.go`	36	`ApiOptions`

`pkg/cmd/attestation/`

File	Line	Symbol
`pkg/cmd/attestation/api/attestation.go`	12	`GetAttestationByRepoAndSubjectDigestPath`
`pkg/cmd/attestation/api/attestation.go`	13	`GetAttestationByOwnerAndSubjectDigestPath`
`pkg/cmd/attestation/api/attestation.go`	24	`AttestationsResponse`
`pkg/cmd/attestation/api/attestation.go`	28	`IntotoStatement`
`pkg/cmd/attestation/api/mock_client.go`	38	`OnGetByDigestSuccess`
`pkg/cmd/attestation/api/mock_client.go`	55	`OnGetByDigestFailure`
`pkg/cmd/attestation/api/mock_client.go`	68	`NewFailTestClient`
`pkg/cmd/attestation/api/trust_domain.go`	3	`MetaPath`
`pkg/cmd/attestation/api/trust_domain.go`	5	`ArtifactAttestations`
`pkg/cmd/attestation/api/trust_domain.go`	13	`MetaResponse`
`pkg/cmd/attestation/artifact/digest/digest.go`	13	`SHA256DigestAlgorithm`
`pkg/cmd/attestation/artifact/digest/digest.go`	14	`SHA512DigestAlgorithm`
`pkg/cmd/attestation/artifact/oci/client.go`	19	`ErrDenied`
`pkg/cmd/attestation/artifact/oci/client.go`	20	`ErrRegistryAuthz`
`pkg/cmd/attestation/artifact/oci/client.go`	44	`ParseReference`
`pkg/cmd/attestation/artifact/oci/mock_client.go`	31	`ReferenceFailClient`
`pkg/cmd/attestation/artifact/oci/mock_client.go`	41	`AuthFailClient`
`pkg/cmd/attestation/artifact/oci/mock_client.go`	51	`DeniedClient`
`pkg/cmd/attestation/artifact/oci/mock_client.go`	61	`NoAttestationsClient`
`pkg/cmd/attestation/artifact/oci/mock_client.go`	74	`FailedToFetchAttestationsClient`
`pkg/cmd/attestation/auth/host.go`	9	`ErrUnsupportedHost`
`pkg/cmd/attestation/download/metadata.go`	14	`ErrAttestationFileCreation`
`pkg/cmd/attestation/download/metadata.go`	16	`MetadataStore`
`pkg/cmd/attestation/download/metadata.go`	20	`LiveStore`
`pkg/cmd/attestation/download/metadata.go`	74	`NewLiveStore`
`pkg/cmd/attestation/inspect/inspect.go`	136	`BundleInspectResult`
`pkg/cmd/attestation/inspect/inspect.go`	140	`BundleInspection`
`pkg/cmd/attestation/inspect/inspect.go`	148	`CertificateInspection`
`pkg/cmd/attestation/inspect/inspect.go`	154	`TlogEntryInspection`
`pkg/cmd/attestation/io/handler.go`	27	`NewTestHandler`
`pkg/cmd/attestation/test/data/data.go`	11	`SigstoreBundleRaw`
`pkg/cmd/attestation/test/data/data.go`	14	`GitHubReleaseBundleRaw`
`pkg/cmd/attestation/test/path.go`	8	`NormalizeRelativePath`
`pkg/cmd/attestation/verification/attestation.go`	20	`ErrUnrecognisedBundleExtension`
`pkg/cmd/attestation/verification/attestation.go`	21	`ErrEmptyBundleFile`
`pkg/cmd/attestation/verification/mock_verifier.go`	16	`MockSigstoreVerifier`
`pkg/cmd/attestation/verification/mock_verifier.go`	53	`NewMockSigstoreVerifier`
`pkg/cmd/attestation/verification/mock_verifier.go`	60	`NewMockSigstoreVerifierWithMockResults`
`pkg/cmd/attestation/verification/mock_verifier.go`	64	`FailSigstoreVerifier`
`pkg/cmd/attestation/verification/mock_verifier.go`	70	`BuildMockResult`
`pkg/cmd/attestation/verification/mock_verifier.go`	95	`BuildSigstoreJsMockResult`
`pkg/cmd/attestation/verification/sigstore.go`	23	`PublicGoodIssuerOrg`
`pkg/cmd/attestation/verification/sigstore.go`	24	`GitHubIssuerOrg`
`pkg/cmd/attestation/verification/sigstore.go`	48	`LiveSigstoreVerifier`
`pkg/cmd/attestation/verification/sigstore.go`	56	`ErrNoAttestationsVerified`
`pkg/cmd/attestation/verification/tuf.go`	19	`GitHubTUFMirror`

`pkg/cmd/auth/`

File	Line	Symbol
`pkg/cmd/auth/gitcredential/helper.go`	21	`CredentialOptions`
`pkg/cmd/auth/logout/logout.go`	16	`LogoutOptions`
`pkg/cmd/auth/refresh/refresh.go`	23	`RefreshOptions`
`pkg/cmd/auth/setupgit/setupgit.go`	19	`SetupGitOptions`
`pkg/cmd/auth/shared/gitcredentials/fake_helper_config.go`	10	`FakeHelperConfig`
`pkg/cmd/auth/switch/switch.go`	16	`SwitchOptions`
`pkg/cmd/auth/token/token.go`	14	`TokenOptions`

`pkg/cmd/browse/`

File	Line	Symbol
`pkg/cmd/browse/browse.go`	30	`BrowseOptions`

`pkg/cmd/codespace/`

File	Line	Symbol
`pkg/cmd/codespace/codespace_selector.go`	13	`CodespaceSelector`
`pkg/cmd/codespace/codespace_selector.go`	65	`SelectName`
`pkg/cmd/codespace/common.go`	39	`NewApp`
`pkg/cmd/codespace/common.go`	149	`SurveyPrompter`
`pkg/cmd/codespace/common.go`	179	`ErrTooManyArgs`
`pkg/cmd/codespace/create.go`	19	`DEVCONTAINER_PROMPT_DEFAULT`
`pkg/cmd/codespace/create.go`	32	`DEFAULT_DEVCONTAINER_DEFINITIONS`
`pkg/cmd/codespace/create.go`	35	`NullableDuration`
`pkg/cmd/codespace/jupyter.go`	32	`Jupyter`
`pkg/cmd/codespace/ports.go`	312	`ForwardPorts`
`pkg/cmd/codespace/ssh.go`	160	`CloseWrite`
`pkg/cmd/codespace/view.go`	55	`ViewCodespace`

`pkg/cmd/config/`

File	Line	Symbol
`pkg/cmd/config/clear-cache/clear_cache.go`	14	`ClearCacheOptions`
`pkg/cmd/config/set/set.go`	90	`ValidateKey`
`pkg/cmd/config/set/set.go`	100	`InvalidValueError`
`pkg/cmd/config/set/set.go`	108	`ValidateValue`

`pkg/cmd/copilot/`

File	Line	Symbol
`pkg/cmd/copilot/copilot.go`	31	`CopilotOptions`

`pkg/cmd/extension/`

File	Line	Symbol
`pkg/cmd/extension/browse/browse.go`	222	`InstallSelected`
`pkg/cmd/extension/browse/browse.go`	226	`RemoveSelected`
`pkg/cmd/extension/browse/browse.go`	236	`Focus`
`pkg/cmd/extension/browse/browse.go`	252	`PageDown`
`pkg/cmd/extension/browse/browse.go`	256	`PageUp`
`pkg/cmd/extension/browse/browse.go`	264	`ScrollDown`
`pkg/cmd/extension/browse/browse.go`	268	`ScrollUp`
`pkg/cmd/extension/browse/browse.go`	276	`FindSelected`
`pkg/cmd/extension/extension.go`	19	`ExtensionKind`
`pkg/cmd/extension/extension.go`	22	`GitKind`
`pkg/cmd/extension/extension.go`	23	`BinaryKind`
`pkg/cmd/extension/extension.go`	24	`LocalKind`
`pkg/cmd/extension/git.go`	32	`CommandOutput`
`pkg/cmd/extension/git.go`	48	`ForRepo`
`pkg/cmd/extension/manager.go`	33	`ErrExtensionExecutableNotFound`
`pkg/cmd/extension/mocks.go`	22	`CommandOutput`
`pkg/cmd/extension/mocks.go`	37	`ForRepo`

`pkg/cmd/factory/`

File	Line	Symbol
`pkg/cmd/factory/remote_resolver.go`	28	`Resolver`

`pkg/cmd/gist/`

File	Line	Symbol
`pkg/cmd/gist/shared/shared.go`	31	`GistOwner`
`pkg/cmd/gist/shared/shared.go`	57	`TruncDescription`

`pkg/cmd/issue/`

File	Line	Symbol
`pkg/cmd/issue/close/close.go`	239	`CloseIssueInput`
`pkg/cmd/issue/develop/develop.go`	22	`DevelopOptions`
`pkg/cmd/issue/lock/lock.go`	94	`LockOptions`
`pkg/cmd/issue/pin/pin.go`	18	`PinOptions`
`pkg/cmd/issue/shared/lookup.go`	101	`PartialLoadError`
`pkg/cmd/issue/transfer/transfer.go`	17	`TransferOptions`
`pkg/cmd/issue/unpin/unpin.go`	18	`UnpinOptions`

`pkg/cmd/label/`

File	Line	Symbol
`pkg/cmd/label/http.go`	47	`OrderBy`

`pkg/cmd/org/`

File	Line	Symbol
`pkg/cmd/org/list/http.go`	9	`OrganizationList`

`pkg/cmd/pr/`

File	Line	Symbol
`pkg/cmd/pr/checkout/checkout.go`	22	`CheckoutOptions`
`pkg/cmd/pr/checkout/checkout.go`	293	`PRResolver`
`pkg/cmd/pr/checkout/checkout.go`	302	`Resolve`
`pkg/cmd/pr/checkout/checkout.go`	329	`Resolve`
`pkg/cmd/pr/checks/checks.go`	35	`ChecksOptions`
`pkg/cmd/pr/create/create.go`	146	`HeadRepo`
`pkg/cmd/pr/create/create.go`	644	`NewIssueState`
`pkg/cmd/pr/create/create.go`	676	`NewCreateContext`
`pkg/cmd/pr/create/regexp_writer.go`	9	`NewRegexpWriter`
`pkg/cmd/pr/create/regexp_writer.go`	13	`RegexpWriter`
`pkg/cmd/pr/diff/diff.go`	27	`DiffOptions`
`pkg/cmd/pr/edit/edit.go`	532	`Surveyor`
`pkg/cmd/pr/edit/edit.go`	541	`FieldsToEdit`
`pkg/cmd/pr/edit/edit.go`	545	`EditFields`
`pkg/cmd/pr/edit/edit.go`	549	`EditableOptionsFetcher`
`pkg/cmd/pr/edit/edit.go`	555	`EditableOptionsFetch`
`pkg/cmd/pr/edit/edit.go`	559	`EditorRetriever`
`pkg/cmd/pr/merge/http.go`	12	`PullRequestMergeMethod`
`pkg/cmd/pr/merge/http.go`	15	`PullRequestMergeMethodMerge`
`pkg/cmd/pr/merge/http.go`	16	`PullRequestMergeMethodRebase`
`pkg/cmd/pr/merge/http.go`	17	`PullRequestMergeMethodSquash`
`pkg/cmd/pr/merge/http.go`	21	`MergeStateStatusBehind`
`pkg/cmd/pr/merge/http.go`	22	`MergeStateStatusBlocked`
`pkg/cmd/pr/merge/http.go`	23	`MergeStateStatusClean`
`pkg/cmd/pr/merge/http.go`	24	`MergeStateStatusDirty`
`pkg/cmd/pr/merge/http.go`	25	`MergeStateStatusHasHooks`
`pkg/cmd/pr/merge/http.go`	26	`MergeStateStatusMerged`
`pkg/cmd/pr/merge/http.go`	27	`MergeStateStatusUnstable`
`pkg/cmd/pr/merge/merge.go`	26	`MergeOptions`
`pkg/cmd/pr/ready/ready.go`	16	`ReadyOptions`
`pkg/cmd/pr/revert/revert.go`	16	`RevertOptions`
`pkg/cmd/pr/review/review.go`	20	`ReviewOptions`
`pkg/cmd/pr/shared/commentable.go`	26	`InputTypeEditor`
`pkg/cmd/pr/shared/commentable.go`	28	`InputTypeWeb`
`pkg/cmd/pr/shared/editable.go`	27	`EditableString`
`pkg/cmd/pr/shared/editable.go`	34	`EditableSlice`
`pkg/cmd/pr/shared/editable.go`	76	`TitleValue`
`pkg/cmd/pr/shared/editable.go`	83	`BodyValue`
`pkg/cmd/pr/shared/editable.go`	90	`AssigneeIds`
`pkg/cmd/pr/shared/find_refs_resolution.go`	116	`RemoteNameToRepoFn`
`pkg/cmd/pr/shared/finder.go`	630	`NewMockFinder`
`pkg/cmd/pr/shared/finder.go`	675	`ExpectFields`
`pkg/cmd/pr/shared/lister.go`	156	`NewMockLister`
`pkg/cmd/pr/shared/lister.go`	179	`ExpectFields`
`pkg/cmd/pr/shared/state.go`	41	`MarkDirty`
`pkg/cmd/pr/shared/survey.go`	145	`RepoMetadataFetch`
`pkg/cmd/pr/shared/survey.go`	153	`RepoMetadataFetcher`
`pkg/cmd/pr/update-branch/update_branch.go`	19	`UpdateBranchOptions`

`pkg/cmd/project/`

File	Line	Symbol
`pkg/cmd/project/item-edit/item_edit.go`	44	`EditProjectDraftIssue`
`pkg/cmd/project/item-edit/item_edit.go`	50	`DraftIssueQuery`
`pkg/cmd/project/item-edit/item_edit.go`	56	`UpdateProjectV2FieldValue`
`pkg/cmd/project/item-edit/item_edit.go`	62	`ClearProjectV2FieldValue`
`pkg/cmd/project/shared/queries/queries.go`	290	`OwnerType`
`pkg/cmd/project/shared/queries/queries.go`	324	`OwnerType`
`pkg/cmd/project/shared/queries/queries.go`	360	`ProjectItemContent`
`pkg/cmd/project/shared/queries/queries.go`	367	`FieldValueNodes`
`pkg/cmd/project/shared/queries/queries.go`	536	`DetailedItem`
`pkg/cmd/project/shared/queries/queries.go`	974	`SingleSelectFieldOptions`
`pkg/cmd/project/shared/queries/queries.go`	1185	`OrgOwner`
`pkg/cmd/project/shared/queries/queries.go`	1186	`ViewerOwner`

`pkg/cmd/release/`

File	Line	Symbol
`pkg/cmd/release/delete-asset/delete_asset.go`	20	`DeleteAssetOptions`
`pkg/cmd/release/shared/attestation.go`	116	`MockVerifier`
`pkg/cmd/release/shared/attestation.go`	120	`NewMockVerifier`
`pkg/cmd/release/shared/fetch.go`	268	`StubFetchRelease`
`pkg/cmd/release/shared/fetch.go`	289	`StubFetchRefSHA`
`pkg/cmd/release/upload/upload.go`	19	`UploadOptions`
`pkg/cmd/release/verify-asset/verify_asset.go`	22	`VerifyAssetOptions`
`pkg/cmd/release/verify-asset/verify_asset.go`	30	`VerifyAssetConfig`
`pkg/cmd/release/verify/verify.go`	25	`VerifyOptions`
`pkg/cmd/release/verify/verify.go`	32	`VerifyConfig`

`pkg/cmd/repo/`

File	Line	Symbol
`pkg/cmd/repo/archive/archive.go`	19	`ArchiveOptions`
`pkg/cmd/repo/autolink/create/create.go`	27	`AutolinkCreateClient`
`pkg/cmd/repo/autolink/create/http.go`	16	`AutolinkCreator`
`pkg/cmd/repo/autolink/create/http.go`	20	`AutolinkCreateRequest`
`pkg/cmd/repo/autolink/delete/delete.go`	27	`AutolinkDeleteClient`
`pkg/cmd/repo/autolink/delete/http.go`	12	`AutolinkDeleter`
`pkg/cmd/repo/autolink/list/http.go`	14	`AutolinkLister`
`pkg/cmd/repo/autolink/list/list.go`	28	`AutolinkListClient`
`pkg/cmd/repo/create/http.go`	251	`IsOrganization`
`pkg/cmd/repo/credits/credits.go`	24	`CreditsOptions`
`pkg/cmd/repo/edit/edit.go`	68	`EditRepositoryInput`
`pkg/cmd/repo/edit/edit.go`	606	`SecurityAndAnalysisInput`
`pkg/cmd/repo/edit/edit.go`	612	`SecurityAndAnalysisStatus`
`pkg/cmd/repo/fork/fork.go`	32	`ForkOptions`
`pkg/cmd/repo/garden/garden.go`	25	`Geometry`
`pkg/cmd/repo/garden/garden.go`	32	`Player`
`pkg/cmd/repo/garden/garden.go`	47	`Cell`
`pkg/cmd/repo/garden/garden.go`	53	`DirUp`
`pkg/cmd/repo/garden/garden.go`	54	`DirDown`
`pkg/cmd/repo/garden/garden.go`	55	`DirLeft`
`pkg/cmd/repo/garden/garden.go`	56	`DirRight`
`pkg/cmd/repo/garden/garden.go`	57	`Quit`
`pkg/cmd/repo/garden/garden.go`	60	`Direction`
`pkg/cmd/repo/garden/garden.go`	89	`GardenOptions`
`pkg/cmd/repo/setdefault/setdefault.go`	41	`SetDefaultOptions`
`pkg/cmd/repo/sync/git.go`	26	`UpdateBranch`
`pkg/cmd/repo/sync/git.go`	35	`CreateBranch`
`pkg/cmd/repo/sync/git.go`	69	`IsAncestor`
`pkg/cmd/repo/sync/git.go`	87	`MergeFastForward`
`pkg/cmd/repo/sync/git.go`	97	`ResetHard`
`pkg/cmd/repo/sync/mocks.go`	11	`UpdateBranch`
`pkg/cmd/repo/sync/mocks.go`	16	`CreateBranch`
`pkg/cmd/repo/sync/mocks.go`	36	`IsAncestor`
`pkg/cmd/repo/sync/mocks.go`	46	`MergeFastForward`
`pkg/cmd/repo/sync/mocks.go`	51	`ResetHard`
`pkg/cmd/repo/sync/sync.go`	24	`SyncOptions`
`pkg/cmd/repo/unarchive/unarchive.go`	18	`UnarchiveOptions`
`pkg/cmd/repo/view/http.go`	19	`RepoReadme`

`pkg/cmd/root/`

File	Line	Symbol
`pkg/cmd/root/alias.go`	19	`NewCmdShellAlias`
`pkg/cmd/root/help.go`	240	`CommandGroup`
`pkg/cmd/root/help_topic.go`	20	`HelpTopics`
`pkg/cmd/root/help_topic.go`	309	`NewCmdHelpTopic`

`pkg/cmd/ruleset/`

File	Line	Symbol
`pkg/cmd/ruleset/check/check.go`	22	`CheckOptions`
`pkg/cmd/ruleset/shared/http.go`	12	`RulesetResponse`

`pkg/cmd/run/`

File	Line	Symbol
`pkg/cmd/run/cancel/cancel.go`	17	`CancelOptions`
`pkg/cmd/run/rerun/rerun.go`	20	`RerunOptions`
`pkg/cmd/run/rerun/rerun.go`	231	`RerunPayload`
`pkg/cmd/run/shared/shared.go`	35	`Neutral`
`pkg/cmd/run/shared/shared.go`	37	`Stale`
`pkg/cmd/run/shared/shared.go`	40	`TimedOut`
`pkg/cmd/run/shared/shared.go`	42	`AnnotationFailure`
`pkg/cmd/run/shared/shared.go`	43	`AnnotationWarning`
`pkg/cmd/run/shared/shared.go`	257	`AnnotationSymbol`
`pkg/cmd/run/shared/shared.go`	326	`RunsPayload`
`pkg/cmd/run/shared/shared.go`	473	`JobsPayload`
`pkg/cmd/run/shared/test.go`	11	`TestRunStartTime`
`pkg/cmd/run/shared/test.go`	13	`TestRun`
`pkg/cmd/run/shared/test.go`	17	`TestRunWithCommit`
`pkg/cmd/run/shared/test.go`	21	`TestRunWithOrgRequiredWorkflow`
`pkg/cmd/run/shared/test.go`	25	`TestRunWithWorkflowAndCommit`
`pkg/cmd/run/shared/test.go`	48	`SuccessfulRun`
`pkg/cmd/run/shared/test.go`	49	`FailedRun`
`pkg/cmd/run/shared/test.go`	51	`TestRuns`
`pkg/cmd/run/shared/test.go`	64	`TestRunsWithOrgRequiredWorkflows`
`pkg/cmd/run/shared/test.go`	82	`SuccessfulJob`
`pkg/cmd/run/shared/test.go`	161	`SkippedJob`
`pkg/cmd/run/shared/test.go`	173	`FailedJob`
`pkg/cmd/run/shared/test.go`	252	`SuccessfulJobAnnotations`
`pkg/cmd/run/shared/test.go`	262	`FailedJobAnnotations`
`pkg/cmd/run/shared/test.go`	272	`TestWorkflow`
`pkg/cmd/run/shared/test.go`	277	`TestExporter`
`pkg/cmd/run/shared/test.go`	282	`MakeTestExporter`
`pkg/cmd/run/view/logs.go`	29	`GetLog`
`pkg/cmd/run/view/logs.go`	40	`GetLog`
`pkg/cmd/run/view/logs.go`	238	`JOB_NAME_MAX_LENGTH`
`pkg/cmd/run/view/view.go`	28	`RunLogCache`
`pkg/cmd/run/view/view.go`	32	`Exists`
`pkg/cmd/run/watch/watch.go`	22	`WatchOptions`

`pkg/cmd/search/`

File	Line	Symbol
`pkg/cmd/search/code/code.go`	19	`CodeOptions`
`pkg/cmd/search/commits/commits.go`	18	`CommitsOptions`
`pkg/cmd/search/repos/repos.go`	19	`ReposOptions`
`pkg/cmd/search/shared/shared.go`	18	`EntityType`

`pkg/cmd/secret/`

File	Line	Symbol
`pkg/cmd/secret/set/http.go`	14	`SecretPayload`
`pkg/cmd/secret/set/http.go`	21	`DependabotSecretPayload`
`pkg/cmd/secret/set/http.go`	28	`PubKey`
`pkg/cmd/secret/shared/base_repo.go`	13	`AmbiguousBaseRepoError`

`pkg/cmd/status/`

File	Line	Symbol
`pkg/cmd/status/status.go`	87	`Notification`
`pkg/cmd/status/status.go`	104	`StatusItem`
`pkg/cmd/status/status.go`	116	`IssueOrPR`
`pkg/cmd/status/status.go`	141	`SearchResult`
`pkg/cmd/status/status.go`	171	`StatusGetter`
`pkg/cmd/status/status.go`	190	`NewStatusGetter`
`pkg/cmd/status/status.go`	204	`CachedClient`
`pkg/cmd/status/status.go`	208	`ShouldExclude`
`pkg/cmd/status/status.go`	217	`CurrentUsername`
`pkg/cmd/status/status.go`	236	`ActualMention`
`pkg/cmd/status/status.go`	622	`HasAuthErrors`

`pkg/cmd/workflow/`

File	Line	Symbol
`pkg/cmd/workflow/disable/disable.go`	16	`DisableOptions`
`pkg/cmd/workflow/enable/enable.go`	16	`EnableOptions`
`pkg/cmd/workflow/run/run.go`	27	`RunOptions`
`pkg/cmd/workflow/run/run.go`	193	`InputAnswer`
`pkg/cmd/workflow/run/run.go`	197	`WriteAnswer`
`pkg/cmd/workflow/run/run.go`	393	`WorkflowInput`
`pkg/cmd/workflow/shared/shared.go`	41	`WorkflowsPayload`
`pkg/cmd/workflow/shared/test.go`	3	`AWorkflow`
`pkg/cmd/workflow/shared/test.go`	9	`AWorkflowContent`
`pkg/cmd/workflow/shared/test.go`	11	`DisabledWorkflow`
`pkg/cmd/workflow/shared/test.go`	18	`DisabledInactivityWorkflow`
`pkg/cmd/workflow/shared/test.go`	25	`AnotherDisabledWorkflow`
`pkg/cmd/workflow/shared/test.go`	32	`UniqueDisabledWorkflow`
`pkg/cmd/workflow/shared/test.go`	39	`AnotherWorkflow`
`pkg/cmd/workflow/shared/test.go`	45	`AnotherWorkflowContent`
`pkg/cmd/workflow/shared/test.go`	47	`YetAnotherWorkflow`

`pkg/cmdutil/`

File	Line	Symbol
`pkg/cmdutil/flags.go`	123	`IsBoolFlag`
`pkg/cmdutil/json_flags.go`	22	`JSONFlagError`
`pkg/cmdutil/json_flags.go`	218	`SetFields`

`pkg/httpmock/`

File	Line	Symbol
`pkg/httpmock/legacy.go`	9	`StubRepoInfoResponse`
`pkg/httpmock/legacy.go`	25	`StubRepoResponse`
`pkg/httpmock/legacy.go`	29	`StubRepoResponseWithPermission`
`pkg/httpmock/legacy.go`	33	`RepoNetworkStubResponse`
`pkg/httpmock/registry.go`	55	`Testing`
`pkg/httpmock/stub.go`	16	`Matcher`
`pkg/httpmock/stub.go`	17	`Responder`
`pkg/httpmock/stub.go`	27	`MatchAny`
`pkg/httpmock/stub.go`	64	`GraphQLMutationMatcher`
`pkg/httpmock/stub.go`	91	`QueryMatcher`
`pkg/httpmock/stub.go`	130	`BinaryResponse`
`pkg/httpmock/stub.go`	136	`WithHost`
`pkg/httpmock/stub.go`	156	`StatusStringResponse`
`pkg/httpmock/stub.go`	162	`JSONResponse`
`pkg/httpmock/stub.go`	191	`FileResponse`
`pkg/httpmock/stub.go`	201	`RESTPayload`
`pkg/httpmock/stub.go`	217	`GraphQLMutation`

`pkg/iostreams/`

File	Line	Symbol
`pkg/iostreams/color.go`	12	`NoTheme`
`pkg/iostreams/color.go`	13	`DarkTheme`
`pkg/iostreams/color.go`	14	`LightTheme`
`pkg/iostreams/color.go`	159	`Magentaf`
`pkg/iostreams/color.go`	188	`Bluef`
`pkg/iostreams/iostreams.go`	23	`DefaultWidth`
`pkg/iostreams/iostreams.go`	95	`ColorSupport256`
`pkg/iostreams/iostreams.go`	102	`HasTrueColor`
`pkg/iostreams/iostreams.go`	140	`SetColorEnabled`
`pkg/iostreams/iostreams.go`	149	`SetStdinTTY`
`pkg/iostreams/iostreams.go`	164	`SetStdoutTTY`
`pkg/iostreams/iostreams.go`	181	`SetStderrTTY`
`pkg/iostreams/iostreams.go`	200	`GetPager`
`pkg/iostreams/iostreams.go`	270	`GetNeverPrompt`
`pkg/iostreams/iostreams.go`	278	`GetSpinnerDisabled`
`pkg/iostreams/iostreams.go`	398	`SetAlternateScreenBufferEnabled`
`pkg/iostreams/iostreams.go`	457	`AccessibleColorsEnabled`
`pkg/iostreams/iostreams.go`	518	`IsTerminalOutput`
`pkg/iostreams/iostreams.go`	522	`IsColorEnabled`
`pkg/iostreams/iostreams.go`	526	`Is256ColorSupported`
`pkg/iostreams/iostreams.go`	530	`IsTrueColorSupported`
`pkg/iostreams/iostreams.go`	534	`Theme`

`pkg/jsoncolor/`

File	Line	Symbol
`pkg/jsoncolor/jsoncolor.go`	19	`JsonWriter`

`pkg/search/`

File	Line	Symbol
`pkg/search/result.go`	130	`TextMatch`
`pkg/search/result.go`	153	`CommitInfo`
`pkg/search/result.go`	161	`CommitUser`
`pkg/search/result.go`	260	`IsBot`

Add godoclint to the enabled linters list with only the require-doc rule enabled (default set to none). This enforces that all exported symbols have godoc comments. Test files are excluded from this check. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add documentation comments to all exported types, functions, methods, constants, and variables in the api/ package to satisfy the godoclint require-doc rule. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…nd internal/prompter Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…ruleset Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…cmd/search Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…root Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add documentation comments to exported symbols across all remaining smaller packages including cmd/gen-docs, context, internal/browser, internal/gh, internal/ghcmd, internal/ghinstance, internal/ghrepo, internal/keyring, internal/run, internal/safepaths, internal/tableprinter, internal/text, internal/update, pkg/cmd/accessibility, pkg/cmd/actions, pkg/cmd/alias, pkg/cmd/api, pkg/cmd/browse, pkg/cmd/cache, pkg/cmd/completion, pkg/cmd/copilot, pkg/cmd/factory, pkg/cmd/gpg-key, pkg/cmd/label, pkg/cmd/licenses, pkg/cmd/org, pkg/cmd/preview, pkg/cmd/ssh-key, pkg/cmd/version, pkg/extensions, pkg/jsoncolor, pkg/markdown, pkg/option, pkg/set, pkg/ssh, pkg/surveyext, test, internal/authflow, and utils. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Replace self-referential comments like 'ToSlice performs the ToSlice operation' with meaningful descriptions of what the symbol actually does. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

babakks · 2026-03-05T12:33:52Z

Now that we're enforcing godocs, I'd recommend us enable the basic set of rules to further improve the documentation practice. Do do that we can just omit the default: none key/value pair, or change it to default: basic. WDYT?

BagToad · 2026-03-12T16:49:59Z

Gonna revisit this in a future one

BagToad and others added 30 commits March 4, 2026 15:18

Add godoc comments to exported symbols in api/

16c6500

Add documentation comments to all exported types, functions, methods, constants, and variables in the api/ package to satisfy the godoclint require-doc rule. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/cmd/pr

5de7a10

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/cmd/attestation

8f7e98c

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/cmd/repo

34d1fb3

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/cmd/run

844963c

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/cmd/project

82f3b3d

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/iostreams

d6ab1b0

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/cmd/extension

520482c

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in git/

72a8fd2

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in internal/codespaces

8a063f6

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/search

2b5dfe2

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/cmd/release

2273310

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in internal/config

7367596

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in internal/featuredetection a…

f9fec82

…nd internal/prompter Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/cmdutil

9331ee8

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/cmd/workflow

7eb76da

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/cmd/issue

0cb2c47

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/cmd/auth

65fcba9

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/cmd/secret

08ef11b

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/cmd/codespace

7618024

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/cmd/gist

83bc80a

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/httpmock

6b227a5

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/cmd/variable

cbedf37

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/cmd/status and pkg/cmd/…

1a51fc6

…ruleset Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/cmd/agent-task and pkg/…

e2e6977

…cmd/search Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add godoc comments to exported symbols in pkg/cmd/config and pkg/cmd/…

df295a1

…root Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Fix gofmt formatting in godoc comments

07744e8

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Improve circular godoc comments flagged in review

50e65e6

Replace self-referential comments like 'ToSlice performs the ToSlice operation' with meaningful descriptions of what the symbol actually does. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

BagToad closed this Mar 12, 2026

babakks mentioned this pull request Mar 24, 2026

Enable godoclint #13018

Closed

babakks linked an issue Mar 24, 2026 that may be closed by this pull request

Enable godoclint #13018

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable godoclint linter with require-doc rule#12841

Enable godoclint linter with require-doc rule#12841
BagToad wants to merge 30 commits intotrunkfrom
enable-godoclint-require-doc

BagToad commented Mar 4, 2026 •

edited

Loading

Uh oh!

babakks commented Mar 5, 2026

Uh oh!

BagToad commented Mar 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

BagToad commented Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Linter configuration

Godoc comments

Verification

api/

git/

internal/codespaces/

internal/config/

internal/featuredetection/

internal/keyring/

internal/prompter/

internal/run/

internal/tableprinter/

internal/text/

internal/update/

pkg/cmd/accessibility/

pkg/cmd/agent-task/

pkg/cmd/alias/

pkg/cmd/api/

pkg/cmd/attestation/

pkg/cmd/auth/

pkg/cmd/browse/

pkg/cmd/codespace/

pkg/cmd/config/

pkg/cmd/copilot/

pkg/cmd/extension/

pkg/cmd/factory/

pkg/cmd/gist/

pkg/cmd/issue/

pkg/cmd/label/

pkg/cmd/org/

pkg/cmd/pr/

pkg/cmd/project/

pkg/cmd/release/

pkg/cmd/repo/

pkg/cmd/root/

pkg/cmd/ruleset/

pkg/cmd/run/

pkg/cmd/search/

pkg/cmd/secret/

pkg/cmd/status/

pkg/cmd/workflow/

pkg/cmdutil/

pkg/httpmock/

pkg/iostreams/

pkg/jsoncolor/

pkg/search/

Uh oh!

babakks commented Mar 5, 2026

Uh oh!

BagToad commented Mar 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

BagToad commented Mar 4, 2026 •

edited

Loading

`api/`

`git/`

`internal/codespaces/`

`internal/config/`

`internal/featuredetection/`

`internal/keyring/`

`internal/prompter/`

`internal/run/`

`internal/tableprinter/`

`internal/text/`

`internal/update/`

`pkg/cmd/accessibility/`

`pkg/cmd/agent-task/`

`pkg/cmd/alias/`

`pkg/cmd/api/`

`pkg/cmd/attestation/`

`pkg/cmd/auth/`

`pkg/cmd/browse/`

`pkg/cmd/codespace/`

`pkg/cmd/config/`

`pkg/cmd/copilot/`

`pkg/cmd/extension/`

`pkg/cmd/factory/`

`pkg/cmd/gist/`

`pkg/cmd/issue/`

`pkg/cmd/label/`

`pkg/cmd/org/`

`pkg/cmd/pr/`

`pkg/cmd/project/`

`pkg/cmd/release/`

`pkg/cmd/repo/`

`pkg/cmd/root/`

`pkg/cmd/ruleset/`

`pkg/cmd/run/`

`pkg/cmd/search/`

`pkg/cmd/secret/`

`pkg/cmd/status/`

`pkg/cmd/workflow/`

`pkg/cmdutil/`

`pkg/httpmock/`

`pkg/iostreams/`

`pkg/jsoncolor/`

`pkg/search/`