Skip to content

DOC: Correct quiver and streamline figure factory return types #5823

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

Open
senanurcetin wants to merge 2 commits into
base: main
Choose a base branch
from
Open

DOC: Correct quiver and streamline figure factory return types #5823

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1cd3b20
docs: clarify figure factory return types (#5396)
senanurcetin Oct 16, 2026
0b3cf5e
docs: use Sphinx rtype for figure factories and drop docstring-only t…
senanurcetin Oct 19, 2026
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
4 changes: 2 additions & 2 deletions plotly/figure_factory/_quiver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ def create_quiver(
x, y, u, v, scale=0.1, arrow_scale=0.3, angle=math.pi / 9, scaleratio=None, **kwargs
):
"""
Returns data for a quiver plot.
Returns a figure for a quiver plot.

:param (list|ndarray) x: x coordinates of the arrow locations
:param (list|ndarray) y: y coordinates of the arrow locations
Expand All @@ -27,7 +27,7 @@ def create_quiver(
for more information on valid kwargs call
help(plotly.graph_objs.Scatter)

:rtype (dict): returns a representation of quiver figure.
:rtype (plotly.graph_objects.Figure): returns a representation of quiver figure.

Example 1: Trivial Quiver

Expand Down
4 changes: 2 additions & 2 deletions plotly/figure_factory/_streamline.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ def create_streamline(
x, y, u, v, density=1, angle=math.pi / 9, arrow_scale=0.09, **kwargs
):
"""
Returns data for a streamline plot.
Returns a figure for a streamline plot.

:param (list|ndarray) x: 1 dimensional, evenly spaced list or array
:param (list|ndarray) y: 1 dimensional, evenly spaced list or array
Expand All @@ -55,7 +55,7 @@ def create_streamline(
for more information on valid kwargs call
help(plotly.graph_objs.Scatter)

:rtype (dict): returns a representation of streamline figure.
:rtype (plotly.graph_objects.Figure): returns a representation of streamline figure.

Example 1: Plot simple streamline and increase arrow size

Expand Down
Loading