From 4483f868f505e171d436c7b64b5f264426d13405 Mon Sep 17 00:00:00 2001 From: Tyler Date: Tue, 4 Oct 2016 00:20:14 -0400 Subject: [PATCH] docd edges' magic methods (comparisons and hashing) --- docs/library.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/library.rst b/docs/library.rst index 3ce40de..7a108eb 100644 --- a/docs/library.rst +++ b/docs/library.rst @@ -9,6 +9,12 @@ graphpy.edge - **vertices** - tuple of length 2 of UndirectedVertex objects - **attrs** + - *__eq__* + - equality is based on the `vertices` property + - *__ne__* + - non-equality is based on the `vertices` property + - *__hash__* + - hashing is based on the `vertices` property - *property* **vertices** - frozenset of the two UndirectedVertex objects this edge connects - *property* **attrs** @@ -42,6 +48,12 @@ graphpy.edge - **vertices** - tuple of length 2 of DirectedVertex objects - **attrs** + - *__eq__* + - equality is based on the `v_from` and `v_to` properties + - *__ne__* + - non-equality is based on the `v_from` and `v_to` properties + - *__hash__* + - hashing is based on the `v_from` and `v_to` properties - *property* **v_from** - DirectedVertex object from which this edge points (the tail) - *property* **v_to**