rust-bitcoin / rust-bitcoin / 12335206012

83%

push

github

Merge rust-bitcoin/rust-bitcoin#3756: units::Amount Make rustdocs conform to the API guidelines

<a class=hub.com/rust-bitcoin/rust-bitcoin/commit/<a class="double-link" href="https://git"><a class=hub.com/rust-bitcoin/rust-bitcoin/commit/01b58d668cf03dda6aeff7c556e359436ccc4132">01b58d668<a href="https://github.com/rust-bitcoin/rust-bitcoin/commit/b1b025febf018ee487f81b38e46a1d3db9deecda"> Add rustdoc examples (Jamil Lambert, PhD)
<a class="double-link" href="https://github.com/rust-bitcoin/rust-bitcoin/commit/b881f1b54e374174281c162124f186af383b788f">b881f1b54</a><a href="https://github.com/rust-bitcoin/rust-bitcoin/commit/b1b025febf018ee487f81b38e46a1d3db9deecda"> Add `# Errors` to rustdocs (Jamil Lambert, PhD)
</a><a class="double-link" href="https://github.com/rust-bitcoin/rust-bitcoin/commit/66f36b304802a4954bbdbc60f43070fa8d687c92">66f36b304</a> Correct doc errors and add links in `unsigned` (Jamil Lambert, PhD)

Pull request description:

  Update rustdocs in `units::Amount` to conform to the API guidelines.

  `# Examples` API guideline quote:
  > "is not always to show how to use the item. ... Rather, an example is often intended to show why someone would want to use the item."

  This guideline is subjective, and in the cases in `Amount` the why is often trivial.  Where the example is trivial it has been included once, and for similar functions left off e.g. included for `from_sat` but not `from_btc`, etc.

ACKs for top commit:
  tcharding:
    ACK 01b58d668cf03dda6aeff7c556e359436ccc4132
  apoelstra:
    ACK 01b58d668cf03dda6aeff7c556e359436ccc4132; successfully ran local tests

Tree-SHA512: 5dde89949de4ef1b61f1e3e9e2bf343002a

20282 of 24461 relevant lines covered (82.92%)

17811.41 hits per line