Skip to content

Commit 0e5ba58

Browse files
mschaueretiennedeg
andauthored
Update developing.md (#81)
* Update developing.md * update `AbstractSimpleGraph` API in developing.md Co-authored-by: Etienne dg <[email protected]>
1 parent f74f0b1 commit 0e5ba58

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/src/developing.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,6 @@ Note that the output does not necessarily have to be a dense matrix, but it must
2727

2828
#### Note on inheriting from AbstractSimpleGraph
2929

30-
Every subtype of AbstractSimpleGraph must return neighbors in ascending order.
30+
Every subtype of `AbstractSimpleGraph` must have vertices forming a `UnitRange` starting from 1 and return `neighbors` in ascending order.
31+
The extend to which code for graph types other than subtypes of `AbstractSimpleGraph` does not rely on `AbstractSimpleGraph` assumptions
32+
needs to be carefully checked, though in principle the requirement is only part of the `AbstractSimpleGraph` API.

0 commit comments

Comments
 (0)