improve InsertTx documentation #569
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
I got this feedback from a River Pro customer who mentioned that we had a better explanation of the reasons to use `InsertTx` on the docs website than we had in the godoc. This attempts to bridge that gap by providing a better explanation in the method comments.
tigrato
pushed a commit
to gravitational/river
that referenced
this pull request
Dec 18, 2024
I got this feedback from a River Pro customer who mentioned that we had a better explanation of the reasons to use `InsertTx` on the docs website than we had in the godoc. This attempts to bridge that gap by providing a better explanation in the method comments.
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.
I got this feedback from a River Pro customer who mentioned that we had a better explanation of the reasons to use
InsertTxon the docs website than we had in the godoc. This attempts to bridge that gap by providing a better explanation in the method comments.