Skip to content

Commit

Permalink
DOC
Browse files Browse the repository at this point in the history
  • Loading branch information
christianbrodbeck committed Oct 16, 2021
1 parent bfe6e68 commit 564317e
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion eelbrain/plot/_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -1958,7 +1958,16 @@ def draw_outline(self, color='k', **kwargs):
self.figure.add_artist(artist)

def save(self, *args, **kwargs):
"Short-cut for Matplotlib's :meth:`~matplotlib.figure.Figure.savefig()`"
"""Short-cut for Matplotlib's :meth:`~matplotlib.figure.Figure.savefig()`
Notes
-----
Important parameters (for details see :meth:`~matplotlib.figure.Figure.savefig()`):
- ``transparent=True`` to save the figure with transparent background.
- ``bbox_inches='tight'`` to ignore the figure boundaries and instead save
an area including all plotted elements.
"""
self.figure.savefig(*args, **kwargs)

def add_hline(self, y, axes=None, *args, **kwargs):
Expand Down

0 comments on commit 564317e

Please sign in to comment.