GODRIVER-2010 Further clean up documentation examples #915
Conversation
This file contains hidden or 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
matthewdale
approved these changes
Apr 20, 2022
There was a problem hiding this comment.
Awesome docs improvements! @benjirewis do we need to do anything to get these rendered in the docs website?
prestonvasquez
approved these changes
Apr 20, 2022
benjirewis
commented
Apr 20, 2022
There was a problem hiding this comment.
@matthewdale let me check with the docs team. I believe they just pull from the current state of the Go driver on master, though.
| if err != nil { | ||
| return err | ||
| } | ||
| defer session1.EndSession(context.TODO()) |
There was a problem hiding this comment.
CausalConsistencyExamples actually left two sessions (session1 and session2) checked out. We always want to defer session.EndSession() when using StartSession. Apologies for not catching this in the initial review, @prestonvasquez. Now that this example is run through mtest, it was failing because two sessions were still checked out.
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.
GODRIVER-2010
Adds a README to
examples/documentation_examplesexplaining the purpose ofexamples.goandexamples_test.go. Replacescontext.Background()withcontext.TODO()is actual example code. Actually runsWithTransactionExample. Usesmtest.ClusterURI()instead of hard-coding URIs. Reorganizesexamples_test.goto usemtestfor server version/topology logic. Adds links to examples pointing to where they appear/will appear on www.mongodb.com/docs.