rust-bitcoin-unsafe-fast/bitcoin
Andrew Poelstra c0de0f7bde
Merge rust-bitcoin/rust-bitcoin#2120: Improve public re-exports
7d695f6b41 Improve public re-exports (Tobin C. Harding)
33774122e0 Remove public re-exports from private module (Tobin C. Harding)

Pull request description:

  Improve the public exports in two ways:

  1. Inline re-exports into the docs of the module that re-exports them.
  2. Separate public and private use statements

  Recently we discussed a way to separate the public and private import statements to make the code more clear and prevent `rustfmt` joining them all together.

  Separate public exports using a code block and `#[rustfmt::skip]`. Has the nice advantage of reducing the number of `#[doc(inline)]` attributes also.

  1. Modules first, as they are part of the project's structure.
  2. Private imports
  3. Public re-exports (using `rustfmt::skip` to prevent merge)

  Use the format

  ```rust
  mod xyz;
  mod abc;

  use ...;

  pub use {
      ...,
  };
  ```

  This patch introduces changes to the rendered HTML docs.

ACKs for top commit:
  apoelstra:
    ACK 7d695f6b41

Tree-SHA512: dc9121c0fe282e3035d862beadb89e2d5a374a7dab6b1c3147a9b5960f8bc2f5af49892f0f713f55c645c46f53464c32daf390c11d85c75553b3ea7e0efc8246
2023-11-15 13:51:51 +00:00
..
contrib hashes: Bump version to 0.13.0 2023-08-24 12:25:42 +10:00
embedded Add patch section to test crates 2023-07-18 10:27:48 +10:00
examples Use Message::from_digest 2023-10-11 08:16:25 +11:00
src Merge rust-bitcoin/rust-bitcoin#2120: Improve public re-exports 2023-11-15 13:51:51 +00:00
tests Replace hex_script macro with a helper function 2023-10-20 10:20:23 +02:00
CHANGELOG.md Add a missing link to #2006 in 'bitcoin/CHANGELOG.md' 2023-10-26 21:06:48 +02:00
Cargo.toml bitcoin: Bump version number to v0.31.0 2023-10-28 08:32:30 +11:00
build.rs Create uniform build script 2023-10-30 14:40:41 +01:00