Skip to content

doc: add documentation overview for grpc, file and datasource packages #1947

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 25 commits into from
Jul 18, 2025
Merged
Show file tree
Hide file tree
Changes from 23 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
9d36b2a
doc: gofr/grpc package documentation overview
olxandr Jun 30, 2025
a8451c8
doc: gofr/datasource package documentation overview
olxandr Jun 30, 2025
9d09f1e
doc: gofr/file package documentation overview
olxandr Jun 30, 2025
60dbe3b
doc: add a dot in the end of a package overview comment for consistency
olxandr Jun 30, 2025
60c8a59
Merge branch 'development' into patch-9
olxandr Jul 1, 2025
5777b8a
Merge branch 'development' into patch-11
olxandr Jul 1, 2025
91d599d
Merge branch 'development' into patch-12
olxandr Jul 1, 2025
b20709f
fix: move grpc package go doc comment to an actual grpc package
olxandr Jul 1, 2025
557afd9
Merge branch 'development' into patch-12
olxandr Jul 1, 2025
c3835b2
Merge branch 'development' into patch-11
olxandr Jul 1, 2025
27b183f
Merge branch 'development' into patch-9
olxandr Jul 1, 2025
5a14c76
Merge branch 'patch-11' into patch-9
olxandr Jul 1, 2025
2f9f967
Merge branch 'patch-12' into patch-9
olxandr Jul 1, 2025
cc10c72
Merge branch 'development' into patch-9
olxandr Jul 1, 2025
7fc910d
Merge branch 'development' into patch-9
Umang01-hash Jul 2, 2025
73ffac1
Merge branch 'development' into patch-9
Umang01-hash Jul 3, 2025
3a6c8a5
Merge branch 'development' into patch-9
Umang01-hash Jul 4, 2025
0b63592
Merge branch 'development' into patch-9
Umang01-hash Jul 8, 2025
7053c63
Merge branch 'gofr-dev:development' into patch-9
olxandr Jul 8, 2025
01fabe5
docs: update package comment for datasource to reflect current usage
olxandr Jul 8, 2025
895934c
Merge branch 'development' into patch-9
Umang01-hash Jul 10, 2025
5088e19
Apply suggestions from code review
olxandr Jul 10, 2025
ee22698
docs: update packages comments according to review
olxandr Jul 10, 2025
30f19a7
Update pkg/gofr/file/file.go
olxandr Jul 11, 2025
87cf7d8
Merge branch 'development' into patch-9
Umang01-hash Jul 16, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions pkg/gofr/datasource/datasource.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/*
Package datasource contains all the supported data sources in GoFr.
A datasource refers to any component that provides access to data — such as databases or message queues.
GoFr comes with built-in support for SQL and Redis data sources out of the box.
*/
package datasource

import "gofr.dev/pkg/gofr/config"
Expand Down
4 changes: 4 additions & 0 deletions pkg/gofr/file/file.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/*
Package file is a simple representation of a file and its metadata.
A file interface provides unified access to various file operations, such as reading and writing files.
*/
package file

type file struct {
Expand Down
1 change: 1 addition & 0 deletions pkg/gofr/grpc/log.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// Package grpc provides gRPC-related additions within the GoFr framework.
package grpc

import (
Expand Down
Loading