From 94b1d398ac8b3026ca789de041260be22564dccc Mon Sep 17 00:00:00 2001
From: Dmitriy Pleshevskiy <dmitriy@ideascup.me>
Date: Fri, 31 Jul 2020 23:34:58 +0300
Subject: [PATCH] doc: add feature info to examples

Closes #1
---
 README.md      |  4 ++++
 src/channel.rs | 20 ++++++++++++++++----
 src/lib.rs     |  4 ++++
 3 files changed, 24 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index d740dce..94fb540 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,8 @@ sonic-channel = { version = "0.2" }
 
 ### Search channel
 
+Note: This example requires enabling the `search` feature, enabled by default.
+
 ```rust
 use sonic_channel::*;
 
@@ -45,6 +47,8 @@ fn main() -> result::Result<()> {
 
 ### Ingest channel
 
+Note: This example requires enabling the `ingest` feature.
+
 ```rust
 use sonic_channel::*;
 
diff --git a/src/channel.rs b/src/channel.rs
index 0c1b8c5..ba3ba6d 100644
--- a/src/channel.rs
+++ b/src/channel.rs
@@ -7,7 +7,6 @@ use std::net::{TcpStream, ToSocketAddrs};
 const DEFAULT_SONIC_PROTOCOL_VERSION: usize = 1;
 const MAX_LINE_BUFFER_SIZE: usize = 20000;
 const UNINITIALIZED_MODE_MAX_BUFFER_SIZE: usize = 200;
-const BUFFER_LINE_SEPARATOR: u8 = '\n' as u8;
 
 macro_rules! init_commands {
     (
@@ -54,15 +53,28 @@ macro_rules! init_commands {
 /// Channel modes supported by sonic search backend.
 #[derive(Debug, Clone, Copy)]
 pub enum ChannelMode {
-    /// Search mode
+    /// Sonic server search channel mode.
+    /// 
+    /// In this mode you can use `query`, `suggest`, `ping` and `quit` commands.
+    /// 
+    /// Note: This mode requires enabling the `search` feature.
     #[cfg(feature = "search")]
     Search,
 
-    /// Ingest mode
+    /// Sonic server ingest channel mode.
+    /// 
+    /// In this mode you can use `push`, `pop`, `flushc`, `flushb`, `flusho`, 
+    /// `ping` and `quit` commands.
+    /// 
+    /// Note: This mode requires enabling the `ingest` feature.
     #[cfg(feature = "ingest")]
     Ingest,
 
-    /// Control mode
+    /// Sonic server control channel mode.
+    /// 
+    /// In this mode you can use `ping` and `quit` commands.
+    /// 
+    /// Note: This mode requires enabling the `control` feature.
     #[cfg(feature = "control")]
     Control,
 }
diff --git a/src/lib.rs b/src/lib.rs
index 463e03d..089f1e8 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -5,6 +5,8 @@
 //! ## Example usage
 //! 
 //! ### Search channel
+//!
+//! Note: This example requires enabling the `search` feature, enabled by default.
 //! 
 //! ```rust
 //! use sonic_channel::*;
@@ -25,6 +27,8 @@
 //! 
 //! ### Ingest channel
 //! 
+//! Note: This example requires enabling the `ingest` feature.
+//!
 //! ```rust
 //! use sonic_channel::*;
 //!