Skip to content
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

doc: Update container package overview #1065

Conversation

JonasBakys0
Copy link
Contributor

Description:

  • Updates incorrect overview for container package
  • issue

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.

pkg/gofr/container/container.go Outdated Show resolved Hide resolved
@JonasBakys0
Copy link
Contributor Author

I dropped the link idea because it seemed too complicated. For example:

  • If I want to use the doc link I face this issue:
    image
  • And with Links, it's hard to maintain them. What if cassandra package location change
// [Cassandra]: https://pkg.go.dev/gofr.dev/pkg/gofr/datasource/cassandra

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 😄

aryanmehrotra
aryanmehrotra previously approved these changes Oct 3, 2024
pkg/gofr/container/container.go Outdated Show resolved Hide resolved
@Umang01-hash
Copy link
Contributor

@JonasBakys0 the tests and the pipeline is failing due to these errors:
Screenshot 2024-10-03 at 3 07 34 PM

Please fix them.

@aryanmehrotra aryanmehrotra merged commit c679acb into gofr-dev:development Oct 4, 2024
10 checks passed
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.

4 participants