DOC-4232 stream code examples #3128
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
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.
Go versions of the examples in this page.
Note: it's difficult to make the output from the stream commands work well with Go testable examples because of the nondeterministic timestamps. I've tried to work around this by explicitly setting the entry IDs to match the ones from the CLI example where possible. However, for the examples that show
XAddwithout setting the IDs, I've just put thefmt.Println()statements inside comments to prevent the output being tested. Doing this also means that some return values from the examples are unused, so I've added anUNUSED()function to allow the examples to compile. If there's a better approach to this then please let me know :-)Also, because I needed to set the IDs, I placed several examples together in the same function in a few places (ie, to avoid making the file huge with loads of
XAddcalls at the start of each example function). This displays OK in the doc page, but let me know if it's a problem from a coding/testing point of view.