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 must_use for mut self key manipulation methods #465

Merged
merged 2 commits into from Jun 28, 2022
Merged

Add must_use for mut self key manipulation methods #465

merged 2 commits into from Jun 28, 2022

Commits on Jun 28, 2022

  1. Put compiler attributes below rustdocs 

    It is conventional, at least within the `rust-bitcoin` organisation to
put compiler attributes _below_ the associated rustdocs.
    @tcharding
    tcharding committed Jun 28, 2022
    Copy the full SHA
    5b86e38 View commit details
    Browse the repository at this point in the history

  2. Add must_use for mut self key manipulation methods 

    We recently added a bunch of key tweaking methods that take `mut self`
and return the tweaked/negated keys. These functions are pure and as
such the returned result is expected to be used. To help downstream
users use the API correctly add `must_use` attributes with a descriptive
error string for each of the methods that takes `mut self`.
    @tcharding
    tcharding committed Jun 28, 2022
    Copy the full SHA
    56f1843 View commit details
    Browse the repository at this point in the history