Skip to content

Commit 7b13174

Browse files
committed
Update the legend documentation
1 parent 5358d33 commit 7b13174

6 files changed

Lines changed: 16 additions & 3 deletions

File tree

docs/.doctrees/drawable.doctree

867 Bytes
Binary file not shown.

docs/.doctrees/environment.pickle

45 Bytes
Binary file not shown.

docs/drawable.html

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -520,7 +520,12 @@ <h2>Visualizations<a class="headerlink" href="#visualizations" title="Permalink
520520
</div>
521521
<div class="section" id="module-legend">
522522
<span id="legend"></span><h2>Legend<a class="headerlink" href="#module-legend" title="Permalink to this headline"></a></h2>
523-
<p>A legend contains a list of labels and their visual representation.</p>
523+
<p>Legends are a common sight in visualizations, and a helpful one as well.
524+
They give a name to the components that you include in your visualization.</p>
525+
<img alt="_images/3-time-series.png" class="example" src="_images/3-time-series.png" />
526+
<p>Legends are alternatives to inline labels in time series.
527+
Multiplex’s legends are drawn just below the caption.
528+
In this way, users can look at the drawn data and understand it immediately.</p>
524529
<dl class="class">
525530
<dt id="legend.Legend">
526531
<em class="property">class </em><code class="sig-prename descclassname">legend.</code><code class="sig-name descname">Legend</code><span class="sig-paren">(</span><em class="sig-param">drawable</em><span class="sig-paren">)</span><a class="headerlink" href="#legend.Legend" title="Permalink to this definition"></a></dt>

docs/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
342 Bytes
Binary file not shown.

multiplex/legend.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
"""
2-
A legend contains a list of labels and their visual representation.
2+
Legends are a common sight in visualizations, and a helpful one as well.
3+
They give a name to the components that you include in your visualization.
4+
5+
.. image:: ../examples/exports/3-time-series.png
6+
:class: example
7+
8+
Legends are alternatives to inline labels in time series.
9+
Multiplex's legends are drawn just below the caption.
10+
In this way, users can look at the drawn data and understand it immediately.
311
"""
412

513
import os

0 commit comments

Comments
 (0)