doc: Update container package overview #1065
Conversation
pkg/gofr/container/container.go
Outdated
| @@ -1,3 +1,6 @@ | |||
| // The container package provides a centralized structure to manage common application-level concerns such as | |||
| // logging, connection pools, and service management. This package is designed to facilitate the sharing and | |||
There was a problem hiding this comment.
can you also include data sources which comprises of different databases, pubsub, filesystem etc.
There was a problem hiding this comment.
Sure. Also, I have a question about documentation in go. I saw that package container is used in many files which made me wonder what is the best way to document such package? How do I choose which file to add documentation?
There was a problem hiding this comment.
container.go is the central file which also has the container struct. So it is the best file.
There was a problem hiding this comment.
I wanted to add some references but couldn't figure out how exactly it works in godoc 😄
Supported data sources:
- Databases ([cassandra], [clickhouse], [mongo], [solr], [dgraph], [sql])
- Key value storages [redis] [kafka]
- Pub/Sub systems ([google], [kafka], [mqtt])
- File system [file]
Results:
Even more links to other packages generate false(not found) URL at least locally
Can you help me with this?
There was a problem hiding this comment.
You may refer to the following documentation
https://tip.golang.org/doc/comment#links
|
I dropped the link idea because it seemed too complicated. For example:
Either way, please correct me if I'm wrong. Go is new to me and don't know how idiomatic documentation should look like in go 😄 |
Description:
Checklist:
goimportandgolangci-lint.