rust-bitcoin-unsafe-fast/internals/src
Andrew Poelstra e96961f333
Merge rust-bitcoin/rust-bitcoin#2798: Standardize rustdoc subheadings
11bb1ff6ff Standardize function doc Safety, Returns and Parameters (jamil.lambert)
df83016c98 Standardize function doc Errors (jamil.lambert)
d219ceb68e Standardize function doc Examples (jamil.lambert)
233a9133d8 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<Self, Error> {
          ...
      }
  }
  ```

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

Tree-SHA512: 163af3cd1cfb47cea3e55eddeaeb6843ff7ec89c57354e3247d6bae85e756b183e8045c2555cfcf87e8c23c1388ff9d7592cfb6a951a37a9ec41d27263e5a2e4
2024-05-25 14:55:16 +00:00
..
error Header change from arguments to parameters 2024-05-22 13:12:44 +01:00
array_vec.rs internals: Implement Default for ArrayVec 2024-02-28 13:19:43 +11:00
const_tools.rs Add tools that help with making code `const` 2023-12-15 01:37:33 +01:00
error.rs Removed //! spare line at end of headers 2024-05-22 12:23:57 +01:00
lib.rs Removed //! spare line at end of headers 2024-05-22 12:23:57 +01:00
macros.rs Standardize function doc Examples 2024-05-24 09:59:42 +01:00
parse.rs Use full path in all macro usage of Result 2024-01-18 19:11:01 +01:00
serde.rs Bump MSRV to Rust version 1.56.1 2023-11-23 06:20:02 +11:00