From b0898ae8fd54d71d73f6e7c0df10c38386b304d2 Mon Sep 17 00:00:00 2001
From: sklv <https://github.com/sklv>
Date: Sun, 12 Apr 2020 11:04:32 +0000
Subject: [PATCH] Add comment explaining Proxy::new argument format.

---
 src/proxy.rs | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/src/proxy.rs b/src/proxy.rs
index 5828337..9e06a37 100644
--- a/src/proxy.rs
+++ b/src/proxy.rs
@@ -61,6 +61,17 @@ impl Proxy {
         self.user.is_some() && self.password.is_some()
     }
 
+    /// Create a proxy from a format string.
+    /// # Arguments:
+    /// * `proxy` - a str of format `<protocol>://<user>:<password>@<host>:port` . All parts except host are optional.
+    /// # Protocols
+    /// * `http`: HTTP Connect
+    /// * `socks`, `socks5`: SOCKS5 (requires socks feature)
+    /// # Examples
+    /// * `http://127.0.0.1:8080`
+    /// * `socks5://john:smith@socks.google.com`
+    /// * `john:smith@socks.google.com:8000`
+    /// * `localhost`
     pub fn new<S: AsRef<str>>(proxy: S) -> Result<Self, Error> {
         let mut proxy_parts = proxy
             .as_ref()