Skip to content

prettify the summary#356

Open
rozyczko wants to merge 1 commit into
developfrom
summary_update_1
Open

prettify the summary#356
rozyczko wants to merge 1 commit into
developfrom
summary_update_1

Conversation

@rozyczko
Copy link
Copy Markdown
Member

This pull request enhances the summary generation in the easyreflectometry module by improving formatting, user interface consistency, and the display of fit statistics. The main changes include restoring and computing the goodness-of-fit value in the HTML summary, introducing utility functions for formatting errors and truncating names with tooltips, and ensuring experiment names are displayed concisely with tooltips for long names.

User interface and formatting improvements:

  • Added _format_error function to ensure parameter errors are formatted consistently with the Analysis table, matching the JavaScript logic in the UI. (src/easyreflectometry/summary/summary.py
  • Introduced _truncate_name function to display long experiment names in a truncated form with tooltips, improving readability and UX in the summary. (src/easyreflectometry/summary/summary.py)

Goodness-of-fit reporting:

  • Restored the "Goodness-of-fit: reduced χ²" row in the HTML refinement summary and implemented _compute_goodness_of_fit to calculate and format the value, or display 'N/A' if unavailable. (src/easyreflectometry/summary/html_templates.py

Codebase improvements:

  • Added imports for escape and quote from the standard library to support HTML escaping and URL encoding in tooltips. (src/easyreflectometry/summary/summary.py

@rozyczko rozyczko added [scope] enhancement Adds/improves features (major.MINOR.patch) [priority] high Should be prioritized soon labels May 21, 2026
Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This pull request does not contain a valid label. Please add one of the following labels: ['chore', 'fix', 'bugfix', 'bug', 'enhancement', 'feature', 'dependencies', 'documentation']

@codecov
Copy link
Copy Markdown

codecov Bot commented May 21, 2026

Codecov Report

❌ Patch coverage is 0% with 38 lines in your changes missing coverage. Please review.
✅ Project coverage is 0.00%. Comparing base (d773e7f) to head (4efd401).

Files with missing lines Patch % Lines
src/easyreflectometry/summary/summary.py 0.00% 38 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           develop    #356   +/-   ##
=======================================
  Coverage     0.00%   0.00%           
=======================================
  Files           40      40           
  Lines         2706    2742   +36     
=======================================
- Misses        2706    2742   +36     
Flag Coverage Δ
integration 0.00% <0.00%> (ø)
unittests 0.00% <0.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
src/easyreflectometry/summary/html_templates.py 0.00% <ø> (ø)
src/easyreflectometry/summary/summary.py 0.00% <0.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[priority] high Should be prioritized soon [scope] enhancement Adds/improves features (major.MINOR.patch)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant