Fix docstring (#930)

kushalkolar · web-flow · commit 262c68a6d376 · 2025-10-23T09:35:28.000-04:00
* fix docstring

* fix docstring

* add docs _gallery to .gitignore

* no edge color for spinning spiral example
diff --git a/.gitignore b/.gitignore
@@ -135,3 +135,4 @@ dmypy.json
 .vscode/
 
 examples/desktop/diffs/*.png
+docs/source/_gallery/
diff --git a/examples/scatter/spinning_spiral.py b/examples/scatter/spinning_spiral.py
@@ -34,7 +34,7 @@
     canvas_kwargs={"max_fps": 500, "vsync": False}
 )
 
-spiral = figure[0, 0].add_scatter(data, cmap="viridis_r", alpha=0.5, sizes=sizes)
+spiral = figure[0, 0].add_scatter(data, cmap="viridis_r", edge_colors=None, alpha=0.5, sizes=sizes)
 
 # pre-generate normally distributed data to jitter the points before each render
 jitter = np.random.normal(scale=0.001, size=n * 3).reshape((n, 3))
diff --git a/fastplotlib/graphics/scatter.py b/fastplotlib/graphics/scatter.py
@@ -101,8 +101,7 @@ def __init__(
             * Matplotlib compatible characters: "osD+x^v<>*".
             * Unicode symbols: "●○■♦♥♠♣✳▲▼◀▶".
             * Emojis: "❤️♠️♣️♦️💎💍✳️📍".
-            * A string containing the value "custom". In this case, the WGSL
-            code defined by ``custom_sdf`` will be used.
+            * A string containing the value "custom". In this case, WGSL code defined by ``custom_sdf`` will be used.
 
         uniform_marker: bool, default False
             Use the same marker for all points. Only valid when `mode` is "markers". Useful if you need to use
diff --git a/fastplotlib/layouts/_graphic_methods_mixin.py b/fastplotlib/layouts/_graphic_methods_mixin.py
@@ -497,11 +497,10 @@ def add_scatter(
             Supported values:
 
             * A string from pygfx.MarkerShape enum
-            * Matplotlib compatible characters: "osD+x^v<>".
+            * Matplotlib compatible characters: "osD+x^v<>*".
             * Unicode symbols: "●○■♦♥♠♣✳▲▼◀▶".
             * Emojis: "❤️♠️♣️♦️💎💍✳️📍".
-            * A string containing the value "custom". In this case, the WGSL
-            code defined by ``custom_sdf`` will be used.
+            * A string containing the value "custom". In this case, WGSL code defined by ``custom_sdf`` will be used.
 
         uniform_marker: bool, default False
             Use the same marker for all points. Only valid when `mode` is "markers". Useful if you need to use

Original file line number	Diff line number	Diff line change
`@@ -135,3 +135,4 @@ dmypy.json`
`135`	`135`	`.vscode/`
`136`	`136`
`137`	`137`	`examples/desktop/diffs/*.png`
	`138`	`+docs/source/_gallery/`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@`
`34`	`34`	`canvas_kwargs={"max_fps": 500, "vsync": False}`
`35`	`35`	`)`
`36`	`36`
`37`		`-spiral = figure[0, 0].add_scatter(data, cmap="viridis_r", alpha=0.5, sizes=sizes)`
	`37`	`+spiral = figure[0, 0].add_scatter(data, cmap="viridis_r", edge_colors=None, alpha=0.5, sizes=sizes)`
`38`	`38`
`39`	`39`	`# pre-generate normally distributed data to jitter the points before each render`
`40`	`40`	`jitter = np.random.normal(scale=0.001, size=n * 3).reshape((n, 3))`