aboutsummaryrefslogtreecommitdiffstats
path: root/doc/tls.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/tls.rst')
-rw-r--r--doc/tls.rst4
1 files changed, 3 insertions, 1 deletions
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