Skip to content

Commit

Permalink
Merge pull request #1180 from Anselmoo/feature/lint
Browse files Browse the repository at this point in the history
fix: 🌱 Reorganize report generation in report.py
  • Loading branch information
Anselmoo authored Feb 18, 2024
2 parents e6a47e9 + 574d29d commit 8c728c9
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions spectrafit/report.py
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ def fit_report_as_dict(
The report contains the best-fit values for the parameters and their
uncertainties and correlations. The report is generated as dictionary and
consits of the following three main criteria:
consists of the following three main criteria:
1. Fit Statistics
2. Fit variables
Expand Down Expand Up @@ -583,20 +583,20 @@ def generate_correlations(self) -> pd.DataFrame:
def generate_report(self) -> Dict[str, pd.DataFrame]:
"""Generate a report.
!!! note "About the Report"
This report contains fit statistics,
correlations of components (if enabled),
and variables and values.
!!! info "About the Report"
This report contains fit statistics, correlations of
components (if enabled), and variables and values.
Returns:
report (Dict[str, pd.DataFrame]): A dictionary containing
the generated report.
"""
report = {}
report["Fit Statistics"] = self.generate_fit_statistics()
report["Variables and Values"] = self.generate_variables()
if self.show_correl:
report["Correlations of Components"] = self.generate_correlations()
report["Variables and Values"] = self.generate_variables()
return report

def __call__(self) -> None:
Expand Down

0 comments on commit 8c728c9

Please sign in to comment.