File 1093-stdlib-Expand-erl_error-s-module-documenta... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1093-stdlib-Expand-erl_error-s-module-documentation.patch of Package erlang (Revision 218b3430555ecf8dc51659dea4ccdb8e)

Currently displaying revision 218b3430555ecf8dc51659dea4ccdb8e , Show latest

From 7841687518581708a7f3cedefb1784ff4dfa50f2 Mon Sep 17 00:00:00 2001
From: Lukas Larsson <lukas@erlang.org>
Date: Mon, 26 Apr 2021 10:26:03 +0200
Subject: [PATCH 13/13] stdlib: Expand erl_error's module documentation

---
 lib/stdlib/doc/src/erl_error.xmlsrc | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/lib/stdlib/doc/src/erl_error.xmlsrc b/lib/stdlib/doc/src/erl_error.xmlsrc
index 1ba04d07e4..ed18eaf728 100644
--- a/lib/stdlib/doc/src/erl_error.xmlsrc
+++ b/lib/stdlib/doc/src/erl_error.xmlsrc
@@ -39,7 +39,13 @@
 </modulesummary>
 
 <description>
- This module provides functions for pretty-printing errors and exceptions.
+ This module provides functions for pretty-printing errors and exceptions. It is used
+ by both the <seeerl marker="stdlib:shell"><c>shell</c></seeerl> and by
+ <seeerl marker="proc_lib"><c>proc_lib</c></seeerl> to print exceptions.
+ It is possible for the module raising an error to provide additional
+ information by calling <seemfa marker="erts:erlang#error/3"><c>error/3</c></seemfa>
+ with extra error information. More details about this mechanism is described
+ in <url href="https://www.erlang.org/erlang-enhancement-proposals/eep-0054.html">EEP-54</url>.
 </description>
 
 <datatypes>
-- 
2.26.2

Places

File 1093-stdlib-Expand-erl_error-s-module-documentation.patch of Package erlang (Revision 218b3430555ecf8dc51659dea4ccdb8e)

Places