Skip to content

Commit

Permalink
fix: 🚨 Refactor class and method names in report.py
Browse files Browse the repository at this point in the history
  • Loading branch information
Anselmoo committed Feb 17, 2024
1 parent a79aada commit 76c9d8a
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions spectrafit/report.py
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ def warn_meassage(msg: str) -> str:


class FitReport:
"""Generates fit reports based on the result of the fitting process.
"""Generate fit reports based on the result of the fitting process.
Args:
inpars (Parameters): The input parameters used for fitting.
Expand Down Expand Up @@ -431,7 +431,7 @@ def __init__(
min_correl: float = 0.0,
modelpars: Optional[Callable[..., Any]] = None,
) -> None:
"""Initializes the Report object.
"""Initialize the Report object.
Args:
inpars (Parameters or object): The input parameters or
Expand Down Expand Up @@ -555,7 +555,7 @@ def generate_variables(self) -> pd.DataFrame:
return pd.DataFrame(variables)

def generate_correlations(self) -> pd.DataFrame:
"""Generates a correlation matrix for the varying parameters.
"""Generate a correlation matrix for the varying parameters.
Returns:
pd.DataFrame: The correlation matrix with the
Expand All @@ -581,7 +581,7 @@ def generate_correlations(self) -> pd.DataFrame:
return correl_matrix

def generate_report(self) -> Dict[str, pd.DataFrame]:
"""Generates a report.
"""Generate a report.
!!! note "About the Report"
This report contains fit statistics,
Expand Down

0 comments on commit 76c9d8a

Please sign in to comment.