File 0816-inets-httpc-Clarify-documentation.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0816-inets-httpc-Clarify-documentation.patch of Package erlang

From 83d2c9a79c949e6120a05055bec1620b9d5662af Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin <ingela@erlang.org>
Date: Mon, 2 Sep 2019 14:38:29 +0200
Subject: [PATCH] inets:httpc - Clarify documentation

The documentation of this function was wrong and confusing. It could be further improved or replaced by a better function in thefuture, depending on how we decide to evolve the httpc client. For now make the documentation more understandable.
---
 lib/inets/doc/src/httpc.xml | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/lib/inets/doc/src/httpc.xml b/lib/inets/doc/src/httpc.xml
index 7451b314ec..72ac79a0b0 100644
--- a/lib/inets/doc/src/httpc.xml
+++ b/lib/inets/doc/src/httpc.xml
@@ -701,15 +701,17 @@
       <type>
 	<v>Profile = profile() | pid()</v>
 	<d>When started <c>stand_alone</c> only the pid can be used.</d>
-	<v>session_info() = {GoodSessions, BadSessions, NonSessions}</v>
-	<v>GoodSessions = session()</v>
-	<v>BadSessions = tuple()</v>
-	<v>NonSessions = term()</v>
+	<v>session_info() = {[session()], [term()],  [term()]}</v>
+	<v>session() = term() - Internal representation of a session</v>
       </type>
       <desc>
-        <p>Produces a slightly processed dump of the session 
-	database. It is intended for debugging. 
-	If no profile is specified, the default profile is used.</p>
+        <p> This function is intended for debugging only. It produces
+        a slightly processed dump of the session database. The first
+        list of the session information tuple will contain session
+        information on an internal format. The last two lists of the
+        session information tuple should always be empty if the code
+        is working as intended. If no profile is specified, the default
+        profile is used.</p>
       </desc>
     </func>
 
-- 
2.16.4

Places

File 0816-inets-httpc-Clarify-documentation.patch of Package erlang

Places