Skip to content

Commit e0cd136

Browse files
Clarify draw_path and stairs date test docstrings
1 parent 6e12d1c commit e0cd136

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

‎plotly/matplotlylib/renderer.py‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -750,11 +750,12 @@ def _draw_filled_path_collection(self, props):
750750
)
751751

752752
def draw_path(self, **props):
753-
"""Draw path, currently only attempts to draw bar charts.
753+
"""Draw a bar chart path or a matplotlib step patch.
754754
755755
This function attempts to sort a given path into a collection of
756-
horizontal or vertical bar charts. Most of the actual code takes
757-
place in functions from mpltools.py.
756+
horizontal or vertical bar charts, and draws matplotlib StepPatch
757+
artists as step traces. Most of the actual code takes place in
758+
functions from mpltools.py.
758759
759760
props.keys() -- [
760761
'data', (a list of vertices for the path)

‎plotly/matplotlylib/tests/test_renderer.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -554,8 +554,7 @@ def test_stairs_converts_to_step_line():
554554

555555

556556
def test_stairs_date_xaxis():
557-
"""Stairs with date x-values must export date strings,
558-
not raw matplotlib date numbers."""
557+
"""Stairs with date x-values must export date strings."""
559558
dates = [
560559
datetime.datetime(2023, 1, 1) + datetime.timedelta(days=i) for i in range(4)
561560
]

0 commit comments

Comments
 (0)