From 3ff4e491456c4cc826366c77caeea0a86d5031fa Mon Sep 17 00:00:00 2001
From: Christophe Prevotaux <nighty@fusen>
Date: Sat, 17 Oct 2020 19:10:18 +0900
Subject: [PATCH] clarified the usage of the error class

---
 doc/lcurl.ldoc | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/lcurl.ldoc b/doc/lcurl.ldoc
index b997847..3cb77fe 100644
--- a/doc/lcurl.ldoc
+++ b/doc/lcurl.ldoc
@@ -168,6 +168,11 @@ end
 --- Curl error object
 -- @type error
 --
+-- !!!NOTE!!!: Always use cURL.safe in order to be able to use the error class functions.
+--             perform() returns true/false and err contains the error message or nil if no error.
+-- @usage
+-- ok, err = context:perform()
+--
 do
 
 --- Get the error category.