Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add comment to help explain txntest.Txn rationale #3571

Closed
wants to merge 1 commit into from
Closed

Add comment to help explain txntest.Txn rationale #3571

wants to merge 1 commit into from

Conversation

michaeldiamant
Copy link
Contributor

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 how txntest.Txn simplifies life.

Test Plan

N/A - Only changes comments.

jannotti
jannotti approved these changes Feb 4, 2022
View reviewed changes
Copy link
Contributor

@jannotti jannotti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

algorandskiy
algorandskiy requested changes Feb 4, 2022
View reviewed changes
Copy link
Contributor

@algorandskiy algorandskiy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@michaeldiamant
Copy link
Contributor Author

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.

@algorandskiy I'm on-board with the suggestion. I replaced the PR with #3574 to address the feedback.

@michaeldiamant michaeldiamant deleted the txntest_comment branch February 4, 2022 21:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@algorandskiy algorandskiy algorandskiy requested changes

@jannotti jannotti jannotti approved these changes

@algochoi algochoi Awaiting requested review from algochoi

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@michaeldiamant @jannotti @algorandskiy