Merge pull request #7 from waywardmonkeys/fix-doc_markdown-lints

Fix `clippy::doc_markdown` lints

src/encode.rs

@@ -62,8 +62,10 @@ pub struct Encoder(DeflateContext);
 impl Encoder {
     /// Creates a new deflate encoder. Note that creating an encoder with this
     /// method allocates a large (200-300k) chunk of data on the stack and is
-    /// likely to cause an overflow if not carefully managed. See the boxed()
+    /// likely to cause an overflow if not carefully managed. See the [`boxed()`]
     /// constructor for a safer method that allocates on the heap.
+    ///
+    /// [`boxed()`]: Self::boxed
     pub fn new() -> Self {
         let flags = make_flags(
             false,

src/lib.rs

@@ -223,11 +223,11 @@
 //!
 //! # Implementation Notes
 //!
-//! The compressor is based heavily on both miniz (<https://github.com/richgel999/miniz>)
-//! by Rich Geldreich and miniz_oxide (<https://github.com/Frommi/miniz_oxide>)
+//! The compressor is based heavily on both [miniz](https://github.com/richgel999/miniz)
+//! by Rich Geldreich and [miniz_oxide](https://github.com/Frommi/miniz_oxide)
 //! by Frommi. The available compression levels and strategies are the same and
 //! it should produce an identical bitstream for a given set of options. The
-//! decompressor is based on the techniques in libdeflate (<https://github.com/ebiggers/libdeflate>)
+//! decompressor is based on the techniques in [libdeflate](https://github.com/ebiggers/libdeflate)
 //! by Eric Biggers.
 
 #![cfg_attr(not(feature = "std"), no_std)]