Skip to content

docs: add package-level GoDoc for undocumented pkg/gofr subdirectories#3252

Open
singhvishalkr wants to merge 1 commit intogofr-dev:developmentfrom
singhvishalkr:docs/enhance-godoc-directories
Open

docs: add package-level GoDoc for undocumented pkg/gofr subdirectories#3252
singhvishalkr wants to merge 1 commit intogofr-dev:developmentfrom
singhvishalkr:docs/enhance-godoc-directories

Conversation

@singhvishalkr
Copy link
Copy Markdown

Pull Request Template

Description:

  • Adds doc.go files with package-level GoDoc comments for the 8 subdirectories under pkg/gofr/ that were missing documentation: cmd, config, migration, rbac, static, testutil, version, and websocket.
  • Closes Enhance GoDoc for the directories section #995.
  • These directories previously appeared with no synopsis on pkg.go.dev and in go doc output. With these additions, all 16 subdirectories now have meaningful descriptions.

Breaking Changes (if applicable):

  • None. This is a documentation-only change with no code modifications.

Additional Information:

  • Comments follow existing project conventions (// Package <name> ... style) and reference exported types using Go doc link syntax (e.g., [Request], [Migrate]).
  • The 8 directories that already had package-level comments in source files (container, datasource, file, grpc, http, logging, metrics, service) are untouched.

Checklist:

  • I have formatted my code using goimport and golangci-lint.
  • All new code is covered by unit tests.
  • This PR does not decrease the overall code coverage.
  • I have reviewed the code comments and documentation for clarity.

Thank you for your contribution!

@singhvishalkr
Copy link
Copy Markdown
Author

Hi team — just wanted to flag that this is a docs-only PR (8 new doc.go files, zero code changes), so it should be a quick review. All comments follow the existing // Package <name> ... convention and reference exported types via Go doc link syntax. Happy to adjust wording if needed!

@singhvishalkr singhvishalkr force-pushed the docs/enhance-godoc-directories branch 3 times, most recently from c8d8fa7 to ef15383 Compare April 9, 2026 09:27
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
@singhvishalkr singhvishalkr force-pushed the docs/enhance-godoc-directories branch 2 times, most recently from 1c78e89 to 6618654 Compare April 11, 2026 18:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Enhance GoDoc for the directories section

1 participant