Skip to content

Fix docstring #930

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
clewis7 merged 4 commits into from
Oct 23, 2025
Merged

Fix docstring #930

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e64a449
fix docstring
kushalkolar Oct 23, 2025
6a1cc6d
fix docstring
kushalkolar Oct 23, 2025
63e1089
add docs _gallery to .gitignore
kushalkolar Oct 23, 2025
d43f083
no edge color for spinning spiral example
kushalkolar Oct 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,3 +135,4 @@ dmypy.json
.vscode/

examples/desktop/diffs/*.png
docs/source/_gallery/
2 changes: 1 addition & 1 deletion examples/scatter/spinning_spiral.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Expand Down
3 changes: 1 addition & 2 deletions fastplotlib/graphics/scatter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 2 additions & 3 deletions fastplotlib/layouts/_graphic_methods_mixin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading