From 80c4294b74f17f1679631b76f23dcd7a4cebbb7b Mon Sep 17 00:00:00 2001
From: Lucas <24826124+Luro02@users.noreply.github.com>
Date: Thu, 5 Sep 2019 18:37:21 +0200
Subject: [PATCH] documented socks proxy (#609)

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

diff --git a/src/proxy.rs b/src/proxy.rs
index 7ee3661..f2818ef 100644
--- a/src/proxy.rs
+++ b/src/proxy.rs
@@ -40,6 +40,14 @@ use winreg::RegKey;
 /// check each `Proxy` in the order it was added. This could mean that a
 /// `Proxy` added first with eager intercept rules, such as `Proxy::all`,
 /// would prevent a `Proxy` later in the list from ever working, so take care.
+///
+/// By enabling the `"socks"` feature it is possible to use a socks proxy:
+/// ```rust
+/// # fn run() -> Result<(), Box<std::error::Error>> {
+/// let proxy = reqwest::Proxy::http("socks5://192.168.1.1:9000")?;
+/// # Ok(())
+/// # }
+/// ```
 #[derive(Clone, Debug)]
 pub struct Proxy {
     intercept: Intercept,