Add note to example

brainglobe · May 20, 2024 · 41a1486 · 41a1486
1 parent d5e292e
commit 41a1486
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/examples/heatmap_human_brain.py b/examples/heatmap_human_brain.py
@@ -1,3 +1,9 @@
+"""
+This example shows how to generate a heatmap with the `allen_human_500um`
+human brain atlas.
+
+N.B. the physical scales are very different to e.g. the small animal atlases.
+"""
 import brainglobe_heatmap as bgh
 
 values = dict(  # scalar values for each region