8000 Improve doc of `Script::push_verify` by Kixunil · Pull Request #1335 · rust-bitcoin/rust-bitcoin · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Improve doc of Script::push_verify #1335

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.

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

Merged
merged 1 commit into from
Oct 21, 2022
Merged

Improve doc of Script::push_verify #1335

merged 1 commit into from
Oct 21, 2022

Conversation

Kixunil
Copy link
Collaborator
@Kixunil Kixunil commented Oct 21, 2022

This rewords the doc to have a reasonable summary, adds a little background explaining the opcode behavior and the effect of the function when called multiple times.

Closes #1154

@Kixunil Kixunil added documentation trivial Obvious, easy and quick to review (few lines or doc-only...) labels Oct 21, 2022
@apoelstra
Copy link
Member

Great, thanks! This is much clearer.

apoelstra
apoelstra previously approved these changes Oct 21, 2022
Copy link
Member
@apoelstra apoelstra left a comment

Choose a reason for hiding this comment

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

ACK 41be988c690d23b3ff250b04be895484534aad92

Copy link
Member
@tcharding tcharding left a comment

Choose a reason for hiding this comment

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

With the added space character: ACK 41be988c690d23b3ff250b04be895484534aad92

/// Adds an `OP_VERIFY` to the script, unless the most-recently-added
/// opcode has an alternate `VERIFY` form, in which case that opcode
/// is replaced e.g., `OP_CHECKSIG` will become `OP_CHECKSIGVERIFY`.
/// Adds an `OP_VERIFY` to the script or replaces the last opcode with VERIFY form
Copy link
Member

Choose a reason for hiding this comment

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

For my learning; is there a reason you do not put a full stop on the brief description?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I guess a bad habit from git.

Copy link
Member

Choose a reason for hiding this comment

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

Ahh, could be :)

This rewords the doc to have a reasonable summary, adds a little background explaining the opcode behavior and the effect of the function when called multiple times.

Closes ##1154
Copy link
Member
@tcharding tcharding left a comment

Choose a reason for hiding this comment

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

ACK 7e39082

Copy link
Member
@apoelstra apoelstra left a comment

Choose a reason for hiding this comment

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

ACK 7e39082

@apoelstra apoelstra merged commit 1d0b721 into master Oct 21, 2022
@apoelstra apoelstra deleted the Kixunil-patch-1 branch October 21, 2022 22:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
trivial Obvious, easy and quick to review (few lines or doc-only...)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Should script::Builder::push_verify() allow duplicate verify pushes?
3 participants
0