Skip to content

Commit e9c9466

Browse files
committed
Updated the documentation of GraphEdgeError
1 parent de49955 commit e9c9466

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/graphs.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -190,18 +190,18 @@ <h2 id="raises">Raises</h2>
190190
</dd>
191191
<dt id="dalpy.graphs.GraphEdgeError"><code class="flex name class">
192192
<span>class <span class="ident">GraphEdgeError</span></span>
193-
<span>(</span><span>source_name, dest_name)</span>
193+
<span>(</span><span>source, dest)</span>
194194
</code></dt>
195195
<dd>
196196
<div class="desc"><p>This class is used by <code><a title="dalpy.graphs.Graph" href="#dalpy.graphs.Graph">Graph</a></code> to raise errors regarding invalid edges.</p>
197197
<p>Initializes a <code><a title="dalpy.graphs.GraphEdgeError" href="#dalpy.graphs.GraphEdgeError">GraphEdgeError</a></code> that will be raised associated with a particular <code><a title="dalpy.graphs.Vertex" href="#dalpy.graphs.Vertex">Vertex</a></code>.</p>
198198
<h2 id="args">Args</h2>
199199
<dl>
200-
<dt><strong><code>source_name</code></strong></dt>
201-
<dd>The string name of the source <code><a title="dalpy.graphs.Vertex" href="#dalpy.graphs.Vertex">Vertex</a></code> of the edge this <code><a title="dalpy.graphs.GraphVertexError" href="#dalpy.graphs.GraphVertexError">GraphVertexError</a></code> is being raised in
200+
<dt><strong><code>source</code></strong></dt>
201+
<dd>The source <code><a title="dalpy.graphs.Vertex" href="#dalpy.graphs.Vertex">Vertex</a></code> of the edge this <code><a title="dalpy.graphs.GraphVertexError" href="#dalpy.graphs.GraphVertexError">GraphVertexError</a></code> is being raised in
202202
association with.</dd>
203-
<dt><strong><code>dest_name</code></strong></dt>
204-
<dd>The string name of the destination <code><a title="dalpy.graphs.Vertex" href="#dalpy.graphs.Vertex">Vertex</a></code> of the edge this <code><a title="dalpy.graphs.GraphVertexError" href="#dalpy.graphs.GraphVertexError">GraphVertexError</a></code> is being raised
203+
<dt><strong><code>dest</code></strong></dt>
204+
<dd>The destination <code><a title="dalpy.graphs.Vertex" href="#dalpy.graphs.Vertex">Vertex</a></code> of the edge this <code><a title="dalpy.graphs.GraphVertexError" href="#dalpy.graphs.GraphVertexError">GraphVertexError</a></code> is being raised
205205
in association with.</dd>
206206
</dl></div>
207207
<h3>Ancestors</h3>

src/dalpy/graphs.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,9 @@ def __init__(self, source, dest):
129129
"""Initializes a `GraphEdgeError` that will be raised associated with a particular `Vertex`.
130130
131131
Args:
132-
source_name: The string name of the source `Vertex` of the edge this `GraphVertexError` is being raised in
132+
source: The source `Vertex` of the edge this `GraphVertexError` is being raised in
133133
association with.
134-
dest_name: The string name of the destination `Vertex` of the edge this `GraphVertexError` is being raised
134+
dest: The destination `Vertex` of the edge this `GraphVertexError` is being raised
135135
in association with.
136136
"""
137137
super().__init__(

0 commit comments

Comments
 (0)