rust-bitcoin / rust-bitcoin / 9858707238

83%

push

github

Merge rust-bitcoin/rust-bitcoin#2957: Fix rustdocs in `units` crate

<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/6dd5af9678c40cac9e360dfcbd9623cdb774c755">6dd5af967<a href="https://github.com/rust-bitcoin/rust-bitcoin/commit/13e27acb161608b376fd11a5286811ea7d45037b"> Add missing links (Jamil Lambert, PhD)
<a class="double-link" href="https://github.com/rust-bitcoin/rust-bitcoin/commit/47e367f01124e4e445d1f62a367ac6d77a01c19e">47e367f01</a><a href="https://github.com/rust-bitcoin/rust-bitcoin/commit/13e27acb161608b376fd11a5286811ea7d45037b"> Standardize error headings (Jamil Lambert, PhD)
</a><a class="double-link" href="https://github.com/rust-bitcoin/rust-bitcoin/commit/75f317a689501a79eea6b04efcda28fa12ccfe46">75f317a68</a><a href="https://github.com/rust-bitcoin/rust-bitcoin/commit/13e27acb161608b376fd11a5286811ea7d45037b"> Fix rustdoc grammar (Jamil Lambert, PhD)
</a><a class="double-link" href="https://github.com/rust-bitcoin/rust-bitcoin/commit/573f8ce724695092ed377fed9338528c4d9cf19b">573f8ce72</a> Add backticks to rustdoc links (Jamil Lambert, PhD)

Pull request description:

  The rustdocs in the `units` crate has been reviewed and improved.

  Some of the links were missing backticks, these have been added.

  Some grammatical changes have been made to improve the documentation.

  The use of links was inconsistent and has been changed to have links everywhere that seemed appropriate.

  A couple of error headings were added and a description as to why a capital M is not accepted in the denomination for MegaSatoshi or MegaBitcoin.

ACKs for top commit:
  apoelstra:
    ACK 6dd5af9678c40cac9e360dfcbd9623cdb774c755
  tcharding:
    ACK 6dd5af9678c40cac9e360dfcbd9623cdb774c755

Tree-SHA512: f5481a7c31ef584f07223018604753495dc

19538 of 23519 relevant lines covered (83.07%)

15640.21 hits per line