From: Sachandhan Ganesh <sachan.ganesh@gmail.com>
Date: Mon, 15 Feb 2021 01:41:03 +0000 (-0800)
Subject: remove unstable features for doc comments
X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;h=f50b00f8f549ed59479a329de350076e7e3f61ec;p=connect-rs.git

remove unstable features for doc comments
---

diff --git a/Cargo.toml b/Cargo.toml
index 79c125e..8922abe 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "connect"
-version = "0.2.3"
+version = "0.2.4"
 edition = "2018"
 authors = ["Sachandhan Ganesh <sachan.ganesh@gmail.com>"]
 description = "message queue abstraction over async network streams"
diff --git a/README.md b/README.md
index 418f5e2..e7c867c 100644
--- a/README.md
+++ b/README.md
@@ -43,7 +43,7 @@ as a practical reference for crate usage.
 - TCP
     - [TCP Echo Server](https://github.com/sachanganesh/connect-rs/tree/main/examples/tcp-echo-server)
     - [TCP Client](https://github.com/sachanganesh/connect-rs/tree/main/examples/tcp-client)
-- TLS
+- TLS (enable `tls` feature flag)
     - [TLS Echo Server](https://github.com/sachanganesh/connect-rs/tree/main/examples/tls-echo-server)
     - [TLS Client](https://github.com/sachanganesh/connect-rs/tree/main/examples/tls-client)
 
@@ -73,9 +73,9 @@ library users can do interesting things such as:
 - Use the recipient tag to signify which serialization format was used for that message
 - Use the recipient tag to signify the type of message being sent
 
-## Contributing
+## Feature Flags
 
-This crate gladly accepts contributions. Don't hesitate to open issues or PRs.
+- `tls`: enables usage of tls transport functionality
 
 ## Feature Status
 
@@ -89,3 +89,7 @@ This crate gladly accepts contributions. Don't hesitate to open issues or PRs.
 | SCTP Server                                         	|        	|
 | DTLS-SCTP Client                                    	|        	|
 | DTLS-SCTP Server                                    	|        	|
+
+## Contributing
+
+This crate gladly accepts contributions. Don't hesitate to open issues or PRs.
diff --git a/src/lib.rs b/src/lib.rs
index ef55dbb..45e6e90 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -33,7 +33,7 @@
 //! - TCP
 //!     - [TCP Echo Server](https://github.com/sachanganesh/connect-rs/tree/main/examples/tcp-echo-server)
 //!     - [TCP Client](https://github.com/sachanganesh/connect-rs/tree/main/examples/tcp-client)
-//! - TLS
+//! - TLS (enable `tls` feature flag)
 //!     - [TLS Echo Server](https://github.com/sachanganesh/connect-rs/tree/main/examples/tls-echo-server)
 //!     - [TLS Client](https://github.com/sachanganesh/connect-rs/tree/main/examples/tls-client)
 //!
@@ -63,6 +63,10 @@
 //! - Use the recipient tag to signify which serialization format was used for that message
 //! - Use the recipient tag to signify the type of message being sent
 //!
+//! # Feature Flags
+//!
+//! - `tls`: enables usage of tls transport functionality
+//!
 
 // #![feature(doc_cfg)]
 
@@ -72,7 +76,7 @@ pub mod tcp;
 mod writer;
 
 #[cfg(feature = "tls")]
-#[doc(cfg(feature = "tls"))]
+// #[doc(cfg(feature = "tls"))]
 pub mod tls;
 
 use async_std::{net::SocketAddr, pin::Pin};
diff --git a/src/tls/mod.rs b/src/tls/mod.rs
index 8e62369..65ded0a 100644
--- a/src/tls/mod.rs
+++ b/src/tls/mod.rs
@@ -20,11 +20,11 @@ pub use client::*;
 pub use listener::*;
 
 #[cfg(feature = "tls")]
-#[doc(cfg(feature = "tls"))]
+// #[doc(cfg(feature = "tls"))]
 pub use async_tls;
 
 #[cfg(feature = "tls")]
-#[doc(cfg(feature = "tls"))]
+// #[doc(cfg(feature = "tls"))]
 pub use rustls;
 
 /// Used to differentiate between an outgoing connection ([Client](`TlsConnectionMetadata::Client`))