Skip to content

Commit

Permalink
add Returns to docstring (#190)
Browse files Browse the repository at this point in the history
  • Loading branch information
adrn committed Jan 28, 2022
1 parent e13b092 commit 9b9af46
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/corner/corner.py
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ def corner(
top_ticks : bool
If true, label the top ticks of each axis
fig : matplotlib.Figure
fig : `~matplotlib.figure.Figure`
Overplot onto the provided figure object, which must either have no
axes yet, or ``ndim * ndim`` axes already present. If not set, the
plot will be drawn on a newly created figure.
Expand All @@ -201,6 +201,11 @@ def corner(
Any remaining keyword arguments are sent to :func:`corner.hist2d` to
generate the 2-D histogram plots.
Returns
-------
fig : `~matplotlib.figure.Figure`
The ``matplotlib`` figure instance for the corner plot.
"""
if arviz_corner is None:
if not (
Expand Down

0 comments on commit 9b9af46

Please sign in to comment.