From: Sachandhan Ganesh <sachan.ganesh@gmail.com>
Date: Sun, 14 Feb 2021 07:12:59 +0000 (-0800)
Subject: fix docs to be more readable
X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;h=2a94e76de26e0c5d084ef2bb077743ae847b6348;p=connect-rs.git

fix docs to be more readable
---

diff --git a/README.md b/README.md
index bdf89a0..65b42dc 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@
 [docs-badge]: https://docs.rs/connect/badge.svg
 [docs-url]: https://docs.rs/connect
 
-This Rust crate provides a simple brokerless message-queue abstraction over asynchronous network
+This Rust crate provides a simple, brokerless message-queue abstraction over asynchronous network
 streams.
 
 ## Examples
diff --git a/src/lib.rs b/src/lib.rs
index 522db96..b3c3232 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,4 +1,4 @@
-//! This crate provides a simple brokerless message-queue abstraction over asynchronous network
+//! This crate provides a simple, brokerless message-queue abstraction over asynchronous network
 //! streams.
 //!
 //! # Examples
diff --git a/src/tls/mod.rs b/src/tls/mod.rs
index a0b7f10..8e62369 100644
--- a/src/tls/mod.rs
+++ b/src/tls/mod.rs
@@ -27,8 +27,8 @@ pub use async_tls;
 #[doc(cfg(feature = "tls"))]
 pub use rustls;
 
-/// Used to differentiate between an outgoing connection ([`TlsConnectionMetadata::Client`]) or
-/// incoming connection listener ([`TlsConnectionMetadata::Listener`]).
+/// Used to differentiate between an outgoing connection ([Client](`TlsConnectionMetadata::Client`))
+/// or incoming connection listener ([Listener](`TlsConnectionMetadata::Listener`)).
 ///
 /// The async TLS library used by this crate has two differing stream types based on whether the
 /// connection being established is either a client or server. This is to aid with handling that