File 0925-Update-digraph.xml.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0925-Update-digraph.xml.patch of Package erlang

From f2cfcafecd0fa52e87ffcc83c35af018482b9644 Mon Sep 17 00:00:00 2001
From: stevensonmt <stevensonmt@users.noreply.github.com>
Date: Sun, 31 Dec 2023 09:12:18 -0800
Subject: [PATCH] Update digraph.xml

Small tweaks to provide some clarity to documentation of the `edge()` type and `add_edge/5`.
---
 lib/stdlib/doc/src/digraph.xml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lib/stdlib/doc/src/digraph.xml b/lib/stdlib/doc/src/digraph.xml
index 8dd7c4ffd0..3e909f45a2 100644
--- a/lib/stdlib/doc/src/digraph.xml
+++ b/lib/stdlib/doc/src/digraph.xml
@@ -146,6 +146,7 @@
     </datatype>
     <datatype>
       <name>edge()</name>
+        <desc><p>Serves as the identifier or "name" of an edge. This is distinct from an edge "label" which attaches ancillary information to the edge rather than identifying the edge itself.</p></desc>
     </datatype>
     <datatype>
       <name name="label"/>
@@ -163,7 +164,7 @@
       <fsummary>Add an edge to a digraph.</fsummary>
       <type name="add_edge_err_rsn"/>
       <desc>
-        <p><c>add_edge/5</c> creates (or modifies) edge <c><anno>E</anno></c>
+        <p><c>add_edge/5</c> creates (or modifies) an edge with the identifier <c><anno>E</anno></c>
           of digraph <c><anno>G</anno></c>, using <c><anno>Label</anno></c> as
           the (new) <seeerl marker="#label">label</seeerl> of the edge. The
           edge is <seeerl marker="#emanate">emanating</seeerl> from
-- 
2.35.3

Places

File 0925-Update-digraph.xml.patch of Package erlang

Places