From 81dc712abfc5e93d996191178e555d0c6af3652d Mon Sep 17 00:00:00 2001
From: Luca Favatella <luca.favatella@erlang-solutions.com>
Date: Mon, 5 Mar 2018 11:05:34 +0000
Subject: inets: refine types and doc of http_uri:parse options

---
 lib/inets/doc/src/http_uri.xml | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

(limited to 'lib/inets/doc')

diff --git a/lib/inets/doc/src/http_uri.xml b/lib/inets/doc/src/http_uri.xml
index 97be292d87..f57214a7ce 100644
--- a/lib/inets/doc/src/http_uri.xml
+++ b/lib/inets/doc/src/http_uri.xml
@@ -118,7 +118,7 @@
         <v>Option = {ipv6_host_with_brackets, boolean()} | 
                     {scheme_defaults, scheme_defaults()} |
                     {fragment, boolean()} |
-                    {scheme_validation_fun, fun()}]</v>
+                    {scheme_validation_fun, fun()}</v>
         <v>Result = {Scheme, UserInfo, Host, Port, Path, Query} |
                     {Scheme, UserInfo, Host, Port, Path, Query, Fragment}</v>
 	<v>Scheme = scheme()</v>
@@ -153,6 +153,13 @@ fun(SchemeStr :: string() | binary()) ->
         <p>It is called before scheme string gets converted into scheme atom and
         thus possible atom leak could be prevented</p>
 
+        <warning>
+          <p>The scheme portion of the URI gets converted into atom,
+          meaning that atom leak may occur. Specifying a scheme
+          validation fun is recommended unless the URI is already
+          sanitized.</p>
+        </warning>
+
         <marker id="encode"></marker>
       </desc>
     </func>
-- 
cgit v1.2.3