Skip to content

Commit 2136091

Browse files
petercorkeclaude
andcommitted
docs: correct three statements in the README's reference lists
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
1 parent 0af373c commit 2136091

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,18 +97,18 @@ Graphs belong to the class `UGraph` or `DGraph` for undirected or directed graph
9797
- `g.incidence()` incidence matrix
9898

9999
### Properties and methods of a vertex
100-
Vertices belong to the class `UVertex` (for undirected graphs) or `DVertex` (for directed graphs), which are each subclasses of `Vertex`.
100+
Vertices belong to the class `UVertex` (for undirected graphs) or `DVertex` (for directed graphs), which are each subclasses of `BaseVertex`.
101101

102102
- `v.coord` the coordinate vector for embedded graph (optional)
103103
- `v.name` the name of the vertex (optional)
104-
- `v.neighbours()` is a list of the neighbouring vertices
104+
- `v.adjacent()` is a list of the adjacent vertices (`neighbours()` and `neighbors()` are the same)
105105
- `v1.samecomponent(v2)` predicate for vertices belonging to the same component
106106

107107
Vertices can be named and referenced by name.
108108

109109
### Properties and methods of an edge
110110
Edges are instances of the class `Edge`.
111-
Edges are not referenced by the graph object, each edge references a pair of vertices, and the vertices reference the edges. For a directed graph only the start vertex of an edge references the edge object, whereas for an undirected graph both vertices reference the edge object.
111+
Each edge references a pair of vertices, the graph lists all of its edges in `g.edges()`, and the vertices reference the edges. For a directed graph only the start vertex of an edge references the edge object, whereas for an undirected graph both vertices reference the edge object.
112112

113113
- `e.cost` cost of edge for planning methods
114114
- `e.next(v)` vertex on edge `e` that is not `v`

0 commit comments

Comments
 (0)