Skip to content

v0.14.3 - Documentation and Configuration Improvements (2026-02-22)

What Changed?

This release updates documentation and default configuration values across example scripts to improve clarity and accuracy. The poll_count default was reduced from 50,000 to 100 for faster device interaction, and the threshold fitting script's option names were standardized for consistency. All docstrings are now synchronized with the actual implementation.

What's New

Enhanced Documentation Accuracy

What it does: This release synchronizes all docstrings and help text across example scripts with their actual implementation, ensuring users receive accurate default values and option names.

Changes include:

  • Updated get_thresholds.py docstring to reflect new nsteps default (50 instead of 10)
  • Standardized fit_thresholds.py options from --step to --step-size in all documentation
  • Fixed all example commands to use correct option names
  • Updated help text references for clarity

How to use it: All example scripts (get_thresholds.py, fit_thresholds.py, plot_thresholds.py) now provide accurate documentation through --help and module docstrings.

Installation

Quick Start

# Get the release
git checkout v0.14.3

# Setup
uv sync

# Run example scripts
uv run examples/get_thresholds.py --help
uv run examples/fit_thresholds.py --help

What's Different from the Last Version?

✅ Added

  • Better documentation synchronization between implementation and docstrings

🔧 Changed

  • poll_count default: 50,000 → 100 (faster device interaction)
  • fit_thresholds.py threshold option naming: --step → --step-size (clarity and consistency)
  • get_thresholds.py nsteps default: 10 → 50 (improved scan resolution)

🐛 Fixed

  • Docstring/implementation mismatches across example scripts
  • Incorrect default values in help documentation
  • Inconsistent option names in help text and examples

Is It Safe to Upgrade?

Backward Compatible: Mostly Yes

  • fit_thresholds.py: --step → --step-size is a breaking change for existing scripts using the old option name. Users should update their scripts to use --step-size.
  • get_thresholds.py and fit_thresholds.py: New default values may affect measurement collection times. Users can explicitly specify previous values if needed.
  • All library APIs remain unchanged and fully backward compatible.

Tests Passed

  • ✅ Builds without errors
  • ✅ Commitizen conventional commits validation
  • ✅ Documentation consistency verified
  • ✅ Example scripts execute with new defaults

Release Details

  • Date: 2026-02-22
  • Version: v0.14.3
  • Files Changed: 3 (options.py, get_thresholds.py, fit_thresholds.py)
  • Commits: 610a41b, 50ca17f, 75a7163

Next Steps

  • Monitor user feedback on new default values, particularly regarding measurement collection times
  • Consider deprecation path for --step option in fit_thresholds.py for future versions
  • Continue improving documentation consistency across all tools and libraries