docs: clarify Demucs segment size help

[be-student]

Closes #246.

The Demucs segment-size help now explains that values are seconds, identifies Default as the model-configured length, and uses a valid 40-second example. The README snapshot and argparse source are updated together, with a regression check covering both.

Validation: all 550 unit tests pass (4 skipped); focused regression, compile, diff, and changed-hunk formatting checks pass. The repository's whole-file Black check remains noisy on the same two pre-existing files.

Summary by CodeRabbit

• Documentation

  • Clarified that Demucs segment size is specified in seconds, within the supported range of 1–100 seconds.
  • Noted that smaller values use less memory.
  • Documented that Default uses the model-configured segment length.
  • Updated the example segment size to 40 seconds.

• Tests

  • Added coverage to verify the CLI help text and README remain consistent.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Team

Run ID: e311ebef-ce85-4064-9063-82a850c4083a

📥 Commits

Reviewing files that changed from the base of the PR and between 720bbd3 and a7b159a.

📒 Files selected for processing (1)

• tests/unit/test_cli.py

🚧 Files skipped from review as they are similar to previous changes (1)

• tests/unit/test_cli.py

Included review availability: Your plan provides up to 4 included reviews per hour; 1 remains after this review.

---

Walkthrough

The Demucs segment-size documentation now uses seconds, explains memory usage and the model-configured default, and replaces the invalid example. A unit test verifies consistency between CLI help and README.md.

Changes

Demucs segment-size documentation

Layer / File(s)	Summary
Align segment-size help and documentation audio_separator/utils/cli.py, README.md, tests/unit/test_cli.py	The CLI help and README now describe segment size in seconds, note that smaller values use less memory, and document Default as the model-configured segment length. The test checks the CLI output and README text.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to a7b15

This change clarifies Demucs segment-size guidance and keeps README and CLI help coverage aligned. No current merge-blocking risk remains.

Poem

A rabbit reads the help text bright
Segment seconds now fit just right
Smaller slices save memory
Default follows the model’s decree
The README and tests agree

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 2 files.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main change: clarifying Demucs segment-size help.
Linked Issues check	✅ Passed	The changes satisfy issue #246 by defining the segment size in seconds, explaining that Default uses the model-configured segment length, and replacing the invalid 256 example with the valid 40-seco…
Out of Scope Changes check	✅ Passed	All changes support the linked issue. The README, CLI help text, and regression test directly address Demucs segment-size documentation.

• Fix all pre-merge checks with AI

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}