docs: add package-level GoDoc for undocumented pkg/gofr subdirectories#3252
Open
singhvishalkr wants to merge 1 commit intogofr-dev:developmentfrom
Open
docs: add package-level GoDoc for undocumented pkg/gofr subdirectories#3252singhvishalkr wants to merge 1 commit intogofr-dev:developmentfrom
singhvishalkr wants to merge 1 commit intogofr-dev:developmentfrom
Conversation
Author
|
Hi team — just wanted to flag that this is a docs-only PR (8 new |
c8d8fa7 to
ef15383
Compare
Add doc.go files with package-level comments for 8 subdirectories under pkg/gofr/ that were missing GoDoc descriptions: cmd, config, migration, rbac, static, testutil, version, and websocket. This ensures all directories display meaningful synopsis text on pkg.go.dev and in go doc output. Closes gofr-dev#995
1c78e89 to
6618654
Compare
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
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.
Pull Request Template
Description:
doc.gofiles with package-level GoDoc comments for the 8 subdirectories underpkg/gofr/that were missing documentation:cmd,config,migration,rbac,static,testutil,version, andwebsocket.go docoutput. With these additions, all 16 subdirectories now have meaningful descriptions.Breaking Changes (if applicable):
Additional Information:
// Package <name> ...style) and reference exported types using Go doc link syntax (e.g.,[Request],[Migrate]).Checklist:
goimportandgolangci-lint.Thank you for your contribution!