Skip to content

fixed documentation #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
liamjdavis merged 2 commits into from
May 24, 2025
Merged

fixed documentation #26

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
35c6365
fixed documentation
BestLocation May 24, 2025
0534aa9
Made change
BestLocation May 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 32 additions & 27 deletions MatPlus/StemPlot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,38 @@


class StemPlot:
"""
A class for creating Stem plots with customizable properties.
The StemPlot class provides a simplified interface for creating stem plots
with customizable axis limits and line properties such as line format, marker format,
and base format.

Parameters:
----------
x : array-like
The x-values of the stem plot.
y : array-like
The y-values of the stem plot.
lowerlimx : float, optional
The lower limit of the x-axis. Default is 90% of the minimum x-value.
lowerlimy : float, optional
The lower limit of the y-axis. Default is 90% of the minimum y-value.
upperlimx : float, optional
The upper limit of the x-axis. Default is 110% of the maximum x-value.
upperlimy : float, optional
The upper limit of the y-axis. Default is 110% of the maximum y-value.
linefmt : str, optional
Format string for the vertical lines in the stem plot. Default is '-'.
markerfmt : str, optional
Format string for the markers at the stem heads. Default is 'o'.
basefmt : str, optional
Format string for the baseline. Default is ' ' (invisible).
label : str, optional
Label for the stem plot. Default is None.
orientation : str, optional
Orientation of the stem plot, either 'vertical' or 'horizontal'. Default is 'vertical'.
"""

def __init__(
self,
x,
Expand All @@ -17,33 +49,6 @@ def __init__(
label=None, # Keep for backward compatibility but it won't be used
orientation="vertical",
):
"""
A class to create stem plots with optional axis limits and styling.
Parameters:
x : array-like
The x-values of the stem plot.
y : array-like
The y-values of the stem plot.
lowerlimx : float, optional
The lower limit of the x-axis.
lowerlimy : float, optional
The lower limit of the y-axis.
upperlimx : float, optional
The upper limit of the x-axis.
upperlimy : float, optional
The upper limit of the y-axis.
linefmt : str, optional
A string defining the properties of the vertical lines in the stem plot.
markerfmt : str, optional
A string defining the properties of the markers at the stem heads.
basefmt : str, optional
A string defining the properties of the baseline.
label : str, optional
The label for the stem plot.
orientation : str, optional
The orientation of the stem plot, either 'vertical' or 'horizontal'.
"""

self.x = np.array(x)
self.y = np.array(y)
self.lowerlimx = lowerlimx
Expand Down