Skip to content

Clarify using the latest voices with Wyoming Piper #4601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AlexGustafsson wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clarify using the latest voices with Wyoming Piper #4601

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion piper/DOCS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ for more information.
[Listen to voice samples](https://rhasspy.github.io/piper-samples/)

Name of the Piper voice to use, such as `en_US-lessac-medium` (the default).
Voice models are automatically downloaded from https://huggingface.co/rhasspy/piper-voices/tree/v1.0.0
Voice models are automatically downloaded from <https://huggingface.co/rhasspy/piper-voices/tree/main>.
To use the latest voices, you may need to use the `update_voices` option.

@coderabbitai coderabbitai Bot May 1, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Use direct, authoritative tone instead of "may".

The sentence uses "may" which should be avoided. Rewrite to be more direct and authoritative.

📝 Proposed fix 
-To use the latest voices, you may need to use the `update_voices` option.
+To use the latest voices, enable the **update_voices** option.

As per coding guidelines: "For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted."

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
To use the latest voices, you may need to use the `update_voices` option.
To use the latest voices, enable the **update_voices** option.
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@piper/DOCS.md` at line 31, Rewrite the sentence in DOCS.md to use a direct,
authoritative tone by removing "may" and fronting the instruction; change "To
use the latest voices, you may need to use the `update_voices` option." to a
direct imperative such as "Use the `update_voices` option to get the latest
voices." Ensure the reference to the `update_voices` option remains exact.


Voices are named according to the following scheme: `<language>_<REGION>-<name>-<quality>`
The `<name>` portion comes from the dataset used to train the voice or the speaker's name if it was provided.
Expand Down