Skip to content

Commit 20f950e

Browse files
erjelnormanrz
andauthored
Fix skeleton doc example (#884)
* copy/paste doc examplee to tests * doc: Fix broken example --------- Co-authored-by: Norman Rzepka <[email protected]>
1 parent 6b80a86 commit 20f950e

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

webknossos/tests/test_skeleton.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,20 @@ def create_dummy_skeleton() -> wk.Skeleton:
5151
return nml
5252

5353

54+
def test_doc_example() -> None:
55+
from webknossos import Annotation
56+
57+
annotation = Annotation(
58+
name="my_annotation", dataset_name="my_dataset", voxel_size=(11, 11, 24)
59+
)
60+
group = annotation.skeleton.add_group("a group")
61+
tree = group.add_tree("a tree")
62+
node_1 = tree.add_node(position=(0, 0, 0), comment="node 1")
63+
node_2 = tree.add_node(position=(100, 100, 100), comment="node 2")
64+
65+
tree.add_edge(node_1, node_2)
66+
67+
5468
def test_immutability() -> None:
5569
skeleton = create_dummy_skeleton()
5670

webknossos/webknossos/skeleton/skeleton.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ class Skeleton(Group):
2323
A small usage example:
2424
2525
```python
26-
annotation = Annotation("my_annotation", voxel_size=(11, 11, 24))
26+
annotation = Annotation(
27+
name="my_annotation", dataset_name="my_dataset", voxel_size=(11, 11, 24)
28+
)
2729
group = annotation.skeleton.add_group("a group")
2830
tree = group.add_tree("a tree")
2931
node_1 = tree.add_node(position=(0, 0, 0), comment="node 1")

0 commit comments

Comments
 (0)