docs: add copy-pasteable usage examples (docs/EXAMPLES.md)#176
Open
seonghobae wants to merge 1 commit into
Open
docs: add copy-pasteable usage examples (docs/EXAMPLES.md)#176seonghobae wants to merge 1 commit into
seonghobae wants to merge 1 commit into
Conversation
Add scenario-based, accuracy-verified examples covering the flows users actually hit: shrinking a folder of recordings, targeting a size (Discord 25MB / email), forcing FLAC vs. letting Opus fall back, splitting >4h recordings at silences, dry-run vs. --execute, and troubleshooting (ffmpeg missing, "has no audio stream", "contains video", too_large). Every command matches a real flag in parse_args; no README content is duplicated and no existing file is modified. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CJRVbDrp1vGYkJgNHMGPpG
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
docs/EXAMPLES.md— a tight, scenario-based examples doc for Codec Carver. New file only; no existing file (including README) is touched.Why
The README documents the flags and one verified command, but new users still have to translate that into "how do I do my thing." This doc gives copy-pasteable recipes for the flows people actually hit.
Contents
--execute)--target-bytes, in bytes) with a quick reference table--flac-all) vs. default FLAC-for-lossless / automatic Opus fallback--max-duration-seconds,--silence-*)--execute--over-limit-only,--size-limit-bytes,--exclude-dir-prefix,--workers/--ffmpeg-threads,--overwrite,--download-icloudtoo_large, and a report-status tableAccuracy
Every command was checked against the real flags and defaults in
parse_args, and behaviors (FLAC→Opus fallback on size, video-stream rejection,too_large/too_longdiscards, dry-run default) were verified against the source.Verification
python3 -m unittest discover -s tests— no new failures (only the 5 pre-existing macOS-onlyos.listxattrerrors)python3 -m interrogate -c pyproject.toml media_shrinker.py saas_web.py mcp_driver.py— PASSED (100%)🤖 Generated with Claude Code