Merge #369: Trivial doc: Warn that serde differs from consensus encoding

52560a9 Warn that serde differs from consensus encoding (Martin Habovstiak)

Pull request description:

  Addresses rust-bitcoin/rust-bitcoin#756 (comment)

ACKs for top commit:
  apoelstra:
    ACK 52560a9

Tree-SHA512: ee56c13dcb0493318f5b59306d6375adb202a5812c4673f0b9abe71fb809b927a74c3fd61aa20fe28fd2176c67f495214bf4da546380dfe9c83b933b02835fff

Author: apoelstra

src/lib.rs

@@ -22,6 +22,7 @@
 //! To minimize dependencies, some functions are feature-gated. To generate
 //! random keys or to re-randomize a context object, compile with the "rand"
 //! feature. To de/serialize objects with serde, compile with "serde".
+//! **Important**: `serde` encoding is **not** the same as consensus encoding!
 //!
 //! Where possible, the bindings use the Rust type system to ensure that
 //! API usage errors are impossible. For example, the library uses context
@@ -124,6 +125,7 @@
 //!                      `global-context-less-secure`.)
 //! * `global-context-less-secure` - enables global context without extra sidechannel protection.
 //! * `serde` - implements serialization and deserialization for types in this crate using `serde`.
+//!           **Important**: `serde` encoding is **not** the same as consensus encoding!
 //! * `bitcoin_hashes` - enables interaction with the `bitcoin-hashes` crate (e.g. conversions).
 
 // Coding conventions