Skip to content

Commit

Permalink
fixing docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
mjgleason committed Aug 4, 2023
1 parent 4de27b1 commit 17f2ffd
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
4 changes: 2 additions & 2 deletions reView/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -516,12 +516,12 @@ def map_column(
default=None,
type=click.IntRange(min=0, max=500),
help=("Width of output histogram. If not specified, default "
"width is 80% of the termimal width."))
"width is 80% of the terminal width."))
@click.option('--height', '-H', required=False,
default=None,
type=click.IntRange(min=0, max=500),
help=("Height of output histogram. If not specified, default "
"height is the smaller of 50% of the terminal width or "
"height is the smaller of 20% of the terminal width or "
"100% of the terminal height."))
def histogram(supply_curve_csv, column, nbins, width, height):
"""
Expand Down
12 changes: 12 additions & 0 deletions reView/utils/plots.py
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,18 @@ def ascii_histogram(df, column, nbins=20, width=None, height=None):
Name of column to plot. Must have a numeric dtype.
nbins : int, optional
Number of bins to plot in the histogram, by default 20.
width : int, optional
Width of the histogram plot (in characters). By default None, which
will set the width to 80% of the terminal width.
height : int, optional
Height of the histogram plot (in characters). By default None, which
will set the width to the smaller of either 20% of the terminal width
or 100% of the terminal height.
Raises
------
TypeError
_description_
"""

if not is_numeric_dtype(df[column]):
Expand Down

0 comments on commit 17f2ffd

Please sign in to comment.