Skip to content

Commit

Permalink
Merge pull request #50 from Arcadia-Science/rl/docs-for-figure-dimens…
Browse files Browse the repository at this point in the history
…ions

add size options to get_figure_dimensions docstring
  • Loading branch information
lanery authored Aug 1, 2024
2 parents 6f940d8 + 12c823a commit c06e142
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion arcadia_pycolor/mpl.py
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,12 @@ def style_plot(


def get_figure_dimensions(size: str) -> tuple[float, ...]:
"Return the dimensions of a figure given a size, subtracting the spacing needed for margins."
"""Return the dimensions of a figure given a size, subtracting the spacing needed for margins.
Args:
size (str) : the desired figure size,
either "full_wide", "full_square", "float_wide", "float_square", or "half_square"
"""

if size not in FIGURE_SIZES:
raise ValueError(f"Size must be one of {list(FIGURE_SIZES.keys())}.")
Expand Down

0 comments on commit c06e142

Please sign in to comment.