Andrew Poelstra f7d637e6aa Merge rust-bitcoin/rust-secp256k1#376: Add examples to `key` module ... aa828f01a5 Improve documentation in the key module (Tobin Harding) 9e46d6f122 Add examples to types and methods in key module (Tobin Harding) a7f3d9bcfd Improve key module docs (Tobin Harding) 6d23614467 Improve lib.rs rustdocs (Tobin Harding) 4c4268f1ad Improve docs on method generate_keypair (Tobin Harding) Pull request description: This PR is an initial attempt to more thoroughly test our public API. Add examples to various types/methods/functions in the key module. I'm not entirely sure when is enough, do we want an example on every single public method, function, and type or is this overkill. In this PR I tried to find a balance by doing ever method/function that took an argument that is a custom type from this lib. I think this should be extended to include return values too though ... Thanks to @thomaseizinger for the idea! First 2 patches are docs improvements to `lib.rs`. ACKs for top commit: apoelstra: ACK aa828f01a5 Tree-SHA512: 9383ad263469f98ce7e988d47edc1482a09a0ce82f43d3991bd80aabdf621430f4a3c86be4debf33232dcb1d60d3e81f2c6d930ea7de7aa0e34b037accd7bc98		2022-01-25 12:34:45 +00:00
..
ecdsa	Fix typo in documentation	2022-01-19 15:22:37 +11:00
constants.rs	Add schnorrsig module	2020-11-10 13:43:34 +09:00
context.rs	Add Debug/Copy/Clone derives	2022-01-12 18:55:06 +11:00
ecdh.rs	Move ECDSA functionality into ECDSA module	2021-11-11 13:43:50 +11:00
key.rs	Merge rust-bitcoin/rust-secp256k1#376: Add examples to `key` module	2022-01-25 12:34:45 +00:00
lib.rs	Merge rust-bitcoin/rust-secp256k1#376: Add examples to `key` module	2022-01-25 12:34:45 +00:00
macros.rs	Dedicated display_secret fn for secret-containing types	2021-09-27 14:03:58 +02:00
schnorr.rs	Deprecate generate_schnorrsig_keypair	2022-01-12 18:23:40 +11:00
secret.rs	Add lints to catch missing traits	2022-01-07 10:28:10 +11:00
serde_util.rs	Remove `visit_bytes` implementation from `FromStrVisitor`	2021-01-13 09:57:09 +11:00