File 1092-otp-Do-not-use-erlang-error-1-2-3-in-docs.... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1092-otp-Do-not-use-erlang-error-1-2-3-in-docs.patch of Package erlang (Revision e6fae69e60dcc1918fd2bc4ae52e9ff8)

Currently displaying revision e6fae69e60dcc1918fd2bc4ae52e9ff8 , Show latest

From 75b4590ab220de1b5c0bf4a58f21c81dcd062334 Mon Sep 17 00:00:00 2001
From: Lukas Larsson <lukas@erlang.org>
Date: Mon, 26 Apr 2021 09:55:25 +0200
Subject: [PATCH 12/13] otp: Do not use erlang:error/1,2,3 in docs

We want to be consistent in the documentation and show
that the erlang:prefix is not needed.
---
 erts/doc/src/erlang.xml                | 2 +-
 system/doc/reference_manual/errors.xml | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
index 38d382f7bf..5c5e0ff86b 100644
--- a/erts/doc/src/erlang.xml
+++ b/erts/doc/src/erlang.xml
@@ -1838,7 +1838,7 @@ example_fun(A1, A2) ->
           <seemfa marker="stdlib:erl_error#format_exception/4"><c>erl_error</c></seemfa>
           to provide more context around an error.</p>
         <p>The default <c>module</c> of the <c><anno>ErrorInfoMap</anno></c> is the
-          module that the call to <seemfa marker="#error/3"><c>erlang:error/3</c></seemfa>
+          module that the call to <seemfa marker="#error/3"><c>error/3</c></seemfa>
           is made. The default <c>function</c> is <c>format_error</c>. See
           <seeerl marker="stdlib:erl_error#format_error"><c>format_error/2</c></seeerl>
           for more details on how this Module:Function/2 is to be used</p>
diff --git a/system/doc/reference_manual/errors.xml b/system/doc/reference_manual/errors.xml
index 3b6b98551c..363abb0315 100644
--- a/system/doc/reference_manual/errors.xml
+++ b/system/doc/reference_manual/errors.xml
@@ -135,7 +135,7 @@
           <item>The second element of the tuple is a map
 	  providing additional information about what caused the
 	  exception. This information can be created by calling
-          <seemfa marker="erts:erlang#error/3"><c>erlang:error/3</c></seemfa>
+          <seemfa marker="erts:erlang#error/3"><c>error/3</c></seemfa>
           and is used by
           <seemfa marker="stdlib:erl_error#format_exception/4">
             <c>erl_error:format_exception/4</c></seemfa>.
-- 
2.26.2

Places

File 1092-otp-Do-not-use-erlang-error-1-2-3-in-docs.patch of Package erlang (Revision e6fae69e60dcc1918fd2bc4ae52e9ff8)

Places