Skip to content

Commit 0b3cf5e

Browse files
committed
docs: use Sphinx rtype for figure factories and drop docstring-only tests
1 parent 1cd3b20 commit 0b3cf5e

3 files changed

Lines changed: 4 additions & 38 deletions

File tree

‎plotly/figure_factory/_quiver.py‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ def create_quiver(
99
x, y, u, v, scale=0.1, arrow_scale=0.3, angle=math.pi / 9, scaleratio=None, **kwargs
1010
):
1111
"""
12-
Returns data for a quiver plot.
12+
Returns a figure for a quiver plot.
1313
1414
:param (list|ndarray) x: x coordinates of the arrow locations
1515
:param (list|ndarray) y: y coordinates of the arrow locations
@@ -27,10 +27,7 @@ def create_quiver(
2727
for more information on valid kwargs call
2828
help(plotly.graph_objs.Scatter)
2929
30-
Returns
31-
-------
32-
plotly.graph_objects.Figure
33-
A Plotly figure containing the quiver arrows.
30+
:rtype (plotly.graph_objects.Figure): returns a representation of quiver figure.
3431
3532
Example 1: Trivial Quiver
3633

‎plotly/figure_factory/_streamline.py‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ def create_streamline(
3838
x, y, u, v, density=1, angle=math.pi / 9, arrow_scale=0.09, **kwargs
3939
):
4040
"""
41-
Returns data for a streamline plot.
41+
Returns a figure for a streamline plot.
4242
4343
:param (list|ndarray) x: 1 dimensional, evenly spaced list or array
4444
:param (list|ndarray) y: 1 dimensional, evenly spaced list or array
@@ -55,10 +55,7 @@ def create_streamline(
5555
for more information on valid kwargs call
5656
help(plotly.graph_objs.Scatter)
5757
58-
Returns
59-
-------
60-
plotly.graph_objects.Figure
61-
A Plotly figure containing the streamlines and arrows.
58+
:rtype (plotly.graph_objects.Figure): returns a representation of streamline figure.
6259
6360
Example 1: Plot simple streamline and increase arrow size
6461

‎tests/test_optional/test_figure_factory/test_return_type_docs.py‎

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)