Merged
Conversation
Most of it is done by running the official migration tool:
golangci-lint migrate
and then some polishing.
Signed-off-by: Babak K. Shandiz <babakks@github.com>
Signed-off-by: Babak K. Shandiz <babakks@github.com>
Signed-off-by: Babak K. Shandiz <babakks@github.com>
This is to fix staticcheck's error code QF1006. Signed-off-by: Babak K. Shandiz <babakks@github.com>
Signed-off-by: Babak K. Shandiz <babakks@github.com>
Signed-off-by: Babak K. Shandiz <babakks@github.com>
There was a problem hiding this comment.
Pull Request Overview
This pull request improves code documentation and linting configuration across the codebase. The changes primarily focus on adding function names to godoc comments to align with Go documentation best practices, fixing typos, and updating the linting infrastructure.
Key changes:
- Added function names to godoc comments for better documentation clarity
- Fixed spelling errors in comments ("wraping" → "wrapping", "searach" → "search")
- Updated golangci-lint configuration to v2 with refined settings
- Removed obsolete build constraint syntax and package documentation from test files
- Simplified loop conditions in BFS traversal logic
Reviewed Changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| pkg/term/env_test.go | Removed redundant package documentation comment from test file |
| pkg/term/console_windows.go | Removed obsolete // +build constraint syntax |
| pkg/term/console.go | Removed obsolete // +build constraint syntax |
| pkg/repository/repository.go | Added function name to godoc comment |
| pkg/markdown/markdown.go | Added function name and corrected spelling in godoc comment |
| pkg/jq/jq.go | Added function names to godoc comments |
| pkg/config/errors.go | Added function names to godoc comments |
| pkg/config/config.go | Added function names and blank lines to godoc comments |
| pkg/api/rest_client.go | Added function name and blank line to godoc comment |
| pkg/api/http_client.go | Added function name and blank line to godoc comment |
| pkg/api/graphql_client.go | Added function name and blank line to godoc comment |
| pkg/api/errors.go | Added function names to godoc comments |
| internal/yamlmap/yaml_map.go | Added function names, fixed spelling, and simplified loop conditions |
| internal/git/url.go | Added function name to godoc comment |
| internal/git/remote.go | Added function name to godoc comment |
| gh.go | Added function name to godoc comment |
| .golangci.yml | Updated to version 2 with expanded linter settings |
| .github/workflows/lint.yml | Updated golangci-lint-action to v8.0.0 with pinned SHA |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
babakks
commented
Oct 31, 2025
| @@ -1,5 +1,3 @@ | |||
| // Package term provides information about the terminal that the current process is connected to (if any), | |||
| // for example measuring the dimensions of the terminal and inspecting whether it's safe to output color. | |||
| package term | |||
Member
Author
There was a problem hiding this comment.
This is redundant since this is a test package, and also the doc is present in pkg/term/env.go:
Lines 1 to 3 in f6d1f60
BagToad
approved these changes
Oct 31, 2025
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
2 participants
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.
Fixes #199
Also, fixed godocs as suggested by
godoclint, but didn't enable the linter.