rust-bitcoin-unsafe-fast/api
merge-script 604cefc781
Merge rust-bitcoin/rust-bitcoin#3802: Rename parameter `rhs` to `weight`
29811ba82c api: Run just check-api (Tobin C. Harding)
0a16382fa3 Rename rhs to weight (Tobin C. Harding)

Pull request description:

  In ops functions we typically use `rhs` but for the more unconventional `checked_*_by_*` functions lets use a more descriptive parameter name.

  Interestingly `cargo public-api` thinks this is an API breaking change. This is obviously an internal change but the api files are updated because the parameter names appear in the api text files.

ACKs for top commit:
  apoelstra:
    ACK 29811ba82cc598d08dc877825ecf8890c48d23b7; successfully ran local tests; sure
  sanket1729:
    ACK 29811ba82c

Tree-SHA512: b44c958ab3ef024c867d81f12819775afa62f1762b96afb93831bb4857ddb9bc95ae5b5f42f32b1a1d23832c69c3cae55f12a80d109fadda7d6763bc764d06aa
2024-12-24 12:54:54 +00:00
..
hashes Add api text files 2024-12-06 15:20:52 +11:00
io Add api text files 2024-12-06 15:20:52 +11:00
primitives api: Run just check-api 2024-12-12 16:28:49 +11:00
units Merge rust-bitcoin/rust-bitcoin#3802: Rename parameter `rhs` to `weight` 2024-12-24 12:54:54 +00:00
README.md api: document the need of cargo nightly 2024-12-15 11:42:52 -03:00

README.md

API text files

Each file here lists the public API when built with some set of features enabled. To create these files run ../contrib/check-for-api-changes.sh:

Requires cargo-public-api, install with:

cargo +nightly install cargo-public-api --locked

ref: https://github.com/enselic/cargo-public-api