@@ -106,7 +106,7 @@ def _normalize_edge(self, edge, layer=None, **kwargs):
106106 Public API convention: multiplex edges are represented as an edge key
107107 `(layer, edge)` at boundaries. Most methods accept either:
108108 - separate arguments: `edge=<tuple>, layer=<str>`
109- - a packed edge key: `edge=(<tuple >, <str >)` and `layer=None`
109+ - a packed edge key: `edge=(<str >, <tuple >)` and `layer=None`
110110
111111 Note: to avoid ambiguity with 2-node hyperedges, a packed edge key is
112112 only inferred when the first element looks like a layer (string).
@@ -242,7 +242,7 @@ def add_edges(
242242
243243 edge_layer : list, optional
244244 The list of layers to which the hyperedges belong. If not provided,
245- `edge_list` must contain packed `(edge, layer )` tuples.
245+ `edge_list` must contain packed `(layer, edge )` tuples.
246246
247247 weights : list, optional
248248 The list of weights of the hyperedges. If the hypergraph is weighted, this must be provided.
@@ -329,7 +329,7 @@ def add_edge(
329329 The hyperedge to add.
330330 layer : str, optional
331331 The layer to which the hyperedge belongs. If not provided, `edge`
332- must be a packed `(edge, layer )` tuple.
332+ must be a packed `(layer, edge )` tuple.
333333 weight : float, optional
334334 The weight of the hyperedge. If the hypergraph is weighted, this must be provided.
335335 metadata : dict, optional
@@ -449,7 +449,7 @@ def set_weight(self, edge, layer=None, weight=None):
449449 Set edge weight.
450450
451451 Accepts:
452- - `set_weight(edge, layer, weight)` (legacy, explicit layer)
452+ - `set_weight(edge, layer, weight)` (explicit layer argument )
453453 - `set_weight((layer, edge), weight=<...>)` (packed edge key)
454454 - `set_weight((layer, edge), <weight>)` (packed edge key, positional weight)
455455 - `set_weight((edge, layer), <weight>)` (legacy packed edge key, positional weight)
0 commit comments