Skip to content

Version 0.4.1 — Bugfix and documentation polish

Choose a tag to compare

View all tags
@vitaliy-ch25 vitaliy-ch25 released this 30 May 11:18
v0.4.1
cb7d8b8
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

What's Changed

  • ResultsCollector.save() now appends .xlsx only when the supplied filename does not already end with .xlsx, preventing double-extension filenames such as results.xlsx.xlsx
  • Unit test test_save_filename_with_xlsx_extension added to verify that a filename passed with .xlsx already present is written without modification
  • Docstrings improved in markers.py and results.py
  • README: collapsible sections added for BibTeX citation block, Revision History, Developer installation, and Developer update; section captions and markup refined; recommended package/environment manager updated to
    Miniforge
  • midpoint() now raises ValueError with a descriptive message (data range and threshold value included) when the threshold is never crossed, replacing a silent IndexError
  • area_cog() now raises ValueError with a descriptive message when the baseline is never crossed from below, or when the area under the curve is zero
  • prepare_part_data() issues warnings.warn() instead of print() when correcting a duplicate timestamp, so the message integrates with standard Python warning filters
  • Unused imports removed from markers.py (phase_to_string) and utils.py (os, scipy.optimize)
  • Unit tests added: test_threshold_never_crossed_raises (TestMidpoint), test_baseline_never_crossed_raises and test_zero_area_raises
    (TestAreaCog)
  • pyproject.toml: keywords, classifiers, and Documentation URL added

See the README for installation instructions and getting started.

Assets 2
Loading