Skip to content

made the docstrings more obvious about the immutability of FitRun - #445

Merged
rozyczko merged 1 commit into
developfrom
434-fitun-doc
Oct 26, 2026
Merged

rozyczko merged 1 commit into
developfrom
434-fitun-doc

Conversation

@rozyczko

Copy link
Copy Markdown
Member
  • Updated the docstring in FitRun (in fitting.py) to explicitly state that the object is frozen, but its pooled and per_dataset dictionaries are mutable and shared, and must be copied before modification.
  • Expanded the docstring for the last_fit property in project.py to reinforce that the returned fit record is read-only history and to reference the updated documentation in FitRun.

@rozyczko rozyczko added [scope] documentation Documentation only changes (major.minor.patch.POST) chore Chore changes to the code [priority] high Should be prioritized soon labels Oct 26, 2026
@codecov

codecov Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.69%. Comparing base (9b5cb2b) to head (b60fa3d).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #445   +/-   ##
========================================
  Coverage    95.69%   95.69%           
========================================
  Files           60       60           
  Lines         7294     7294           
========================================
  Hits          6980     6980           
  Misses         314      314           
Flag Coverage Δ
integration 38.93% <ø> (ø)
unittests 95.69% <ø> (ø)

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

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

@rozyczko
rozyczko merged commit f7c6d66 into develop Oct 26, 2026
58 of 61 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Chore changes to the code [priority] high Should be prioritized soon [scope] documentation Documentation only changes (major.minor.patch.POST)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant