Fix documentation compilability.

Author: arik-so

lightning/src/lib.rs

@@ -165,50 +165,16 @@ pub mod io {
 		/// Cursor initial position is `0` even if underlying buffer (e.g., [`Vec`])
 		/// is not empty. So writing to cursor starts with overwriting [`Vec`]
 		/// content, not with appending to it.
-		///
-		/// # Examples
-		///
-		/// ```
-		/// use bitcoin::io::Cursor;
-		///
-		/// let buff = Cursor::new(Vec::new());
-		/// # fn force_inference(_: &Cursor<Vec<u8>>) {}
-		/// # force_inference(&buff);
-		/// ```
 		pub fn new(inner: T) -> Cursor<T> {
 			Cursor { pos: 0, inner }
 		}
 
 		/// Consumes this cursor, returning the underlying value.
-		///
-		/// # Examples
-		///
-		/// ```
-		/// use bitcoin::io::Cursor;
-		///
-		/// let buff = Cursor::new(Vec::new());
-		/// # fn force_inference(_: &Cursor<Vec<u8>>) {}
-		/// # force_inference(&buff);
-		///
-		/// let vec = buff.into_inner();
-		/// ```
 		pub fn into_inner(self) -> T {
 			self.inner
 		}
 
 		/// Gets a reference to the underlying value in this cursor.
-		///
-		/// # Examples
-		///
-		/// ```
-		/// use bitcoin::io::Cursor;
-		///
-		/// let buff = Cursor::new(Vec::new());
-		/// # fn force_inference(_: &Cursor<Vec<u8>>) {}
-		/// # force_inference(&buff);
-		///
-		/// let reference = buff.get_ref();
-		/// ```
 		pub fn get_ref(&self) -> &T {
 			&self.inner
 		}
@@ -217,61 +183,16 @@ pub mod io {
 		///
 		/// Care should be taken to avoid modifying the internal I/O state of the
 		/// underlying value as it may corrupt this cursor's position.
-		///
-		/// # Examples
-		///
-		/// ```
-		/// use bitcoin::io::Cursor;
-		///
-		/// let mut buff = Cursor::new(Vec::new());
-		/// # fn force_inference(_: &Cursor<Vec<u8>>) {}
-		/// # force_inference(&buff);
-		///
-		/// let reference = buff.get_mut();
-		/// ```
 		pub fn get_mut(&mut self) -> &mut T {
 			&mut self.inner
 		}
 
 		/// Returns the current position of this cursor.
-		///
-		/// # Examples
-		///
-		/// ```
-		/// use core2::io::{Cursor, Seek, SeekFrom};
-		/// use std::io::prelude::*;
-		///
-		/// let mut buff = Cursor::new(vec![1, 2, 3, 4, 5]);
-		///
-		/// assert_eq!(buff.position(), 0);
-		///
-		/// buff.seek(SeekFrom::Current(2)).unwrap();
-		/// assert_eq!(buff.position(), 2);
-		///
-		/// buff.seek(SeekFrom::Current(-1)).unwrap();
-		/// assert_eq!(buff.position(), 1);
-		/// ```
 		pub fn position(&self) -> u64 {
 			self.pos
 		}
 
 		/// Sets the position of this cursor.
-		///
-		/// # Examples
-		///
-		/// ```
-		/// use core2::io::Cursor;
-		///
-		/// let mut buff = Cursor::new(vec![1, 2, 3, 4, 5]);
-		///
-		/// assert_eq!(buff.position(), 0);
-		///
-		/// buff.set_position(2);
-		/// assert_eq!(buff.position(), 2);
-		///
-		/// buff.set_position(4);
-		/// assert_eq!(buff.position(), 4);
-		/// ```
 		pub fn set_position(&mut self, pos: u64) {
 			self.pos = pos;
 		}

lightning/src/util/ser_macros.rs

@@ -456,7 +456,7 @@ macro_rules! _decode_tlv_stream_match_check {
 /// For example,
 /// ```
 /// # use lightning::decode_tlv_stream;
-/// # fn read<R: lightning::io::Read> (stream: R) -> Result<(), lightning::ln::msgs::DecodeError> {
+/// # fn read<R: lightning::io::Read> (stream: &mut R) -> Result<(), lightning::ln::msgs::DecodeError> {
 /// let mut required_value = 0u64;
 /// let mut optional_value: Option<u64> = None;
 /// decode_tlv_stream!(stream, {