Add module docstring for annotations.analysis

1 year ago · 266408b99b
parent 51fdef55bd
commit 266408b99b
1 changed files with 5 additions and 0 deletions
--- a/birdvisu/annotations/analysis.py
+++ b/birdvisu/annotations/analysis.py
@ -1,3 +1,8 @@
+"""Analysis annotators
+
+The annotators provided here are mostly concerned about the graph properties of
+the topologies."""
+
 from . import Annotator, Annotation
 from ..topo_v3 import MetricType
 import heapq