docs: extend Couchbase docs #971
Merged
Conversation
This file contains 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
✅ Deploy Preview for testcontainers-go ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
|
@alihanyalcin could you please take a look? I'm extending the docs for the recently added Couchbase module. Thanks in advance! |
|
Kudos, SonarCloud Quality Gate passed!
|
|
Hi @mdelapenya, LGTM! 🚀 |
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.
What does this PR do?
It adds a module reference section in the docs, describing each exposed function in the public API, including code snippets extracted from the code.
At the same time, we are adding Go docs for the public API.
Finally, we are moving the test methods to a test package, so that we demonstrate the real usage of the module from inside.
Render URL: https://deploy-preview-971--testcontainers-go.netlify.app/modules/couchbase
Why is it important?
Make the module more usable through docs
Related issues