Skip to content

v0.18.5 - Fix --hit-type Option in Example Scripts (2026-03-06)

What Changed?

This release fixes incorrect CLI usage examples in check_event_rate.py and check_coincidence.py. The --hit-types option has been renamed to --hit-type (singular) to better reflect how Typer handles list[int] options — each value is passed by repeating the flag once per value. All example commands in docstrings and help text have been updated accordingly.

What's New

Main Feature: --hit-type Option (renamed from --hit-types)

What it does: Renames the CLI option from --hit-types to --hit-type in check_event_rate.py and check_coincidence.py. Typer's list[int] options require the flag to be repeated for each value, so the singular form is more intuitive.

How to use it:

# Select specific hit_types (check_event_rate.py)
uv run check_event_rate.py ./data --resample 60s --hit-type 1 --hit-type 2 --hit-type 4 --hit-type 7

# Filter for multi-layer hits (check_coincidence.py)
uv run check_coincidence.py ./detA ./detB --hit-type 1 --hit-type 2 --hit-type 4 --hit-type 7

Installation

Quick Start

# Get the release
git checkout 0.18.5

# Setup
uv sync

# Run CLI
uv run kazunoko --help

What's Different from the Last Version?

🔧 Changed

  • check_event_rate.py: renamed --hit-types to --hit-type; fixed usage examples in module docstring and command docstring
  • check_coincidence.py: renamed --hit-types to --hit-type; fixed usage examples in module docstring, options help text, and command docstring
  • Taskfile.yml: fixed docs:release and push:release tasks to accept version without v prefix
  • CLAUDE.md: updated release procedure documentation

Is It Safe to Upgrade?

Backward Compatible: No (CLI option renamed)

  • Users of check_event_rate.py and check_coincidence.py must update their scripts to use --hit-type instead of --hit-types.

Tests Passed

  • Commitizen pre-commit hook passed on all commits
  • Builds without errors

Release Details

  • Date: 2026-03-06
  • Version: v0.18.5
  • Files Changed: 2 example scripts
  • Commits: 6b3d0e0, b20c8db, 01908aa, 7d63316

Next Steps

  • Consider applying the same --hit-type singular convention to any future CLI options that accept repeated list values.