Skip to content

Commit 4aeff26

Browse files
committed
docs(marker_shapes): fix shape default (None, not circle), scope note, substitute-your-names guidance
1 parent f0c7d66 commit 4aeff26

1 file changed

Lines changed: 12 additions & 4 deletions

File tree

‎tutorials/marker_shapes.ipynb‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,8 @@
9595
"source": [
9696
"## 1. The default — circles\n",
9797
"\n",
98-
"Circle elements are drawn as circles. `shape=\"circle\"` is the default."
98+
"The default is `shape=None`, which renders each element as its stored geometry — circles here.\n",
99+
"Passing `shape=\"circle\"` is equivalent for circle elements."
99100
]
100101
},
101102
{
@@ -185,7 +186,11 @@
185186
"\n",
186187
"Visium spots sit on a hexagonal grid, and are often drawn as touching hexagons rather than dots.\n",
187188
"`shape=\"visium_hex\"` does exactly that. We switch to the real Visium mouse-brain section and colour by\n",
188-
"its brain-region clusters."
189+
"its brain-region clusters.\n",
190+
"\n",
191+
"We switch datasets because the synthetic `blobs_circles` are not a real hexagonal grid. The element\n",
192+
"name (`\"spots\"`) and the columns (`\"cluster\"`, `\"total_counts\"`) below are specific to this dataset —\n",
193+
"inspect `sdata.shapes` and the annotating table's columns to find the equivalents in your own data."
189194
]
190195
},
191196
{
@@ -242,7 +247,9 @@
242247
"## 4. Combining `shape=` with colour and outline\n",
243248
"\n",
244249
"`shape=` composes with the usual styling — colour by a column, add an outline, set `fill_alpha` (see\n",
245-
"the *Styling shapes and labels* tutorial)."
250+
"the *Styling shapes and labels* tutorial).\n",
251+
"\n",
252+
"(See the *Legends and colorbars* example for `legend_loc` and `colorbar_params`.)"
246253
]
247254
},
248255
{
@@ -285,7 +292,8 @@
285292
"\n",
286293
"- Circle elements (Visium spots, `blobs_circles`) carry a centre and radius; `shape=` chooses the\n",
287294
" marker they are drawn with, leaving the geometry unchanged.\n",
288-
"- `shape=` accepts `\"circle\"` (default), `\"hex\"`, `\"square\"`, and `\"visium_hex\"`.\n",
295+
"- `shape=` accepts `None` (the default, render as-is), `\"circle\"`, `\"hex\"`, `\"square\"`, and\n",
296+
" `\"visium_hex\"`; this tutorial uses circle elements (centre + radius), which `shape=` is designed for.\n",
289297
"- `shape=\"visium_hex\"` renders Visium spots as a touching hex grid — the familiar Visium look.\n",
290298
"- `shape=` composes with colour, outline, and the other styling arguments."
291299
]

0 commit comments

Comments
 (0)