rust-bitcoin / rust-bitcoin / 9236282583

83%

push

github

Merge rust-bitcoin/rust-bitcoin#2798: Standardize rustdoc subheadings

<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/11bb1ff6ff65e89d9f101ffb7d76ebc09a20d738">11bb1ff6f<a href="https://github.com/rust-bitcoin/rust-bitcoin/commit/e96961f333a0de2f1495298342594d3ad2556624"> Standardize function doc Safety, Returns and Parameters (jamil.lambert)
<a class="double-link" href="https://github.com/rust-bitcoin/rust-bitcoin/commit/df83016c98bdcb069c1579d9f1fa7f74139214c0">df83016c9</a><a href="https://github.com/rust-bitcoin/rust-bitcoin/commit/e96961f333a0de2f1495298342594d3ad2556624"> Standardize function doc Errors (jamil.lambert)
</a><a class="double-link" href="https://github.com/rust-bitcoin/rust-bitcoin/commit/d219ceb68eb60e646e0daf2fe963c76839151464">d219ceb68</a><a href="https://github.com/rust-bitcoin/rust-bitcoin/commit/e96961f333a0de2f1495298342594d3ad2556624"> Standardize function doc Examples (jamil.lambert)
</a><a class="double-link" href="https://github.com/rust-bitcoin/rust-bitcoin/commit/233a9133d82bb90f9e57f7a56d87b719d94b99f1">233a9133d</a> Standardize function doc Panics (jamil.lambert)

Pull request description:

  The subheadings in the rustdocs have been standardized according to [./CONTRIBUTING.md](https://github.com/rust-bitcoin/rust-bitcoin/blob/master/CONTRIBUTING.md):
  ```rust
  impl FooBar {
      /// Constructs a `FooBar` from a [`Baz`].
      ///
      /// # Errors
      ///
      /// Returns an error if `Baz` is not ...
      ///
      /// # Panics
      ///
      /// If the `Baz`, converted to a `usize`, is out of bounds.
      pub fn from_baz(baz: Baz) -> Result {
          ...
      }
  }
  ```

ACKs for top commit:
  apoelstra:
    ACK 11bb1ff6ff65e89d9f101ffb7d76ebc09a20d738
  tcharding:
    ACK 11bb1ff6ff65e89d9f101ffb7d76ebc09a20d738

Tree-SHA512: 163af3cd157354e3247e8c23c1363e5a2e4

19320 of 23190 relevant lines covered (83.31%)

16697.66 hits per line