Skip to content

Commit

Permalink
Mention GMT docs regarding more complicated legends in gallery exampl…
Browse files Browse the repository at this point in the history
…e "Legends" (#2606)
  • Loading branch information
yvonnefroehlich authored Jul 19, 2023
1 parent c1923ac commit 953b0e9
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion examples/gallery/embellishments/legend.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,12 @@
The :meth:`pygmt.Figure.legend` method can automatically create a legend for
symbols plotted using :meth:`pygmt.Figure.plot`. Legend entries are only
created when the ``label`` parameter is used.
created when the ``label`` parameter is used. For more complicated legends,
including legends with multiple columns, users have to write an ASCII file
with instructions for the layout of the legend items and pass it
to the ``spec`` parameter of :meth:`pygmt.Figure.legend`. For details on
how to set up such a file, please see the GMT documentation at
https://docs.generic-mapping-tools.org/latest/legend.html#legend-codes.
"""
import pygmt

Expand Down

0 comments on commit 953b0e9

Please sign in to comment.