Add comment to help explain txntest.Txn rationale #3571
Closed
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
algorandskiy
requested changes
Feb 4, 2022
Contributor
algorandskiy
left a comment
algorandskiy
left a comment
There was a problem hiding this comment.
I personally do not think it is a good practice to refer to another PR. If more explanation needed add a summary comment right in the code.
Contributor
Author
@algorandskiy I'm on-board with the suggestion. I replaced the PR with #3574 to address the feedback. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
Adds inline comment linking to the PR that created
txntest.Txn. For developers new to go-algorand, the originating PR provides context to help understand howtxntest.Txnsimplifies life.Test Plan
N/A - Only changes comments.