From ae4685b6d65870530148dcb0d50d8bcc89692230 Mon Sep 17 00:00:00 2001
From: lloyd <lloyd@randombit.net>
Date: Wed, 31 Oct 2012 00:29:34 +0000
Subject: Clarify meaning of Alert::is_fatal

---
 doc/tls.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'doc')

diff --git a/doc/tls.rst b/doc/tls.rst
index f148e632d..ac862d25a 100644
--- a/doc/tls.rst
+++ b/doc/tls.rst
@@ -644,7 +644,9 @@ be of type ``NULL_ALERT``.
 
   .. cpp:function:: is_fatal() const
 
-       Return if this alert is fatal or a warning alert
+       Return true if this alert is fatal. A fatal alert causes the
+       connection to be immediately disconnected. Otherwise, the alert
+       is a warning and the connection remains valid.
 
   .. cpp:function:: Type type() const
 
-- 
cgit v1.2.3