rust-bitcoin-unsafe-fast/bitcoin
Tobin C. Harding 2157e69857 Document the `all` module
The `all` module enables usage of a wildcard import statement without
muddying the scope with any other types defined in `opcodes`, in other
words if one wants to use the `All` type `opcodes::All` is the most
clear way to use it, however usage of naked `OP_FOO` types is perfectly
clear.

Add documentation stating that we guarantee to never put anything else
in the `all` module so folks are confident using a wildcard import will
not bring any rubbish into scope.

Expected usage in downstream applications that need types in `opcodes`
as well as the opcodes:

```
        use bitcoin::opcodes::all::*;
        use bitcoin::opcodes;
```

Also, we do no implement `Ord` or `PartialOrd`, document this including
HTML tags hiding an example bug from Bitcoin Core that shows why not.
2022-11-06 06:12:10 +11:00
..
contrib Merge rust-bitcoin/rust-bitcoin#999: examples: Add taproot PSBT example workflow 2022-10-25 16:47:18 +00:00
examples Fix broken build due to conflict between #1340 and #999 2022-10-25 22:04:38 +00:00
src Document the `all` module 2022-11-06 06:12:10 +11:00
test_data Add a workspace to the top level directory. 2022-09-13 08:44:57 +10:00
Cargo.toml Merge rust-bitcoin/rust-bitcoin#999: examples: Add taproot PSBT example workflow 2022-10-25 16:47:18 +00:00