Skip to content

docs(cn): fix basic usage example to match English README#990

Open
Br1an67 wants to merge 2 commits into2noise:devfrom
Br1an67:fix/cn-readme-usage-example
Open

docs(cn): fix basic usage example to match English README#990
Br1an67 wants to merge 2 commits into2noise:devfrom
Br1an67:fix/cn-readme-usage-example

Conversation

@Br1an67
Copy link

@Br1an67 Br1an67 commented Mar 1, 2026

Summary

Fixes #866

The Chinese README (docs/cn/README.md) basic usage code example was out of sync with the English README:

  1. Only saved the first generated wav (wavs[0]) instead of all wavs in a loop
  2. Missing try/except for torchaudio version compatibility (unsqueeze(0) needed in some versions)

Changes

  • docs/cn/README.md: Updated basic usage code to loop over all generated wavs with torchaudio version compatibility handling, matching the English README

Verification

Compared with the English README to confirm the fix matches.

Sync the Chinese README basic usage code with the English version:
- Save all generated wavs in a loop instead of only the first one
- Handle torchaudio version compatibility with try/except

Fixes 2noise#866
@github-actions github-actions bot changed the base branch from main to dev March 1, 2026 06:18
Copy link
Member

@fumiama fumiama left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please do not change other codes but doc only.

@fumiama fumiama added the documentation Improvements or additions to documentation label Mar 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

中文README.md中基础用法的代码有误

2 participants