From 76c9d8af86145c5797ae4324fdb82097ad9b9e14 Mon Sep 17 00:00:00 2001 From: Anselm Hahn Date: Sat, 17 Feb 2024 23:29:45 +0100 Subject: [PATCH] fix: :rotating_light: Refactor class and method names in report.py --- spectrafit/report.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/spectrafit/report.py b/spectrafit/report.py index 7462c4d19..10e45ca80 100644 --- a/spectrafit/report.py +++ b/spectrafit/report.py @@ -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. @@ -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 @@ -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 @@ -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,