From 2f502078fd0f56e3e61e58f1d57ae15f9f736ffe Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Wed, 14 Nov 2018 10:55:23 +0100
Subject: Document the PROXY-related functions; prepare 1.7.0

---
 src/ranch.erl | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'src')

diff --git a/src/ranch.erl b/src/ranch.erl
index 894f78b..814e928 100644
--- a/src/ranch.erl
+++ b/src/ranch.erl
@@ -257,6 +257,10 @@ handshake(Ref, Opts) ->
 		end
 	end.
 
+%% Unlike handshake/2 this function always return errors because
+%% the communication between the proxy and the server are expected
+%% to be reliable. If there is a problem while receiving the proxy
+%% header, we probably want to know about it.
 -spec recv_proxy_header(ref(), timeout())
 	-> {ok, ranch_proxy_header:proxy_info()}
 	| {error, closed | atom()}
-- 
cgit v1.2.3