Skip to content

docs: align diarization config field name with openapi#107

Open
lrossillon-gladia wants to merge 1 commit intomainfrom
fix/diarization-number-of-speakers-doc
Open

docs: align diarization config field name with openapi#107
lrossillon-gladia wants to merge 1 commit intomainfrom
fix/diarization-number-of-speakers-doc

Conversation

@lrossillon-gladia
Copy link

@lrossillon-gladia lrossillon-gladia commented Feb 12, 2026

Summary by CodeRabbit

  • Documentation
    • Updated speaker diarization configuration documentation to reflect the correct field naming convention for improved clarity and consistency.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 12, 2026

📝 Walkthrough

Walkthrough

Documentation update to rename a diarization configuration field from diarization_config.num_of_speakers to diarization_config.number_of_speakers in the speaker diarization feature guide, ensuring consistency across descriptions, hints, and examples.

Changes

Cohort / File(s) Summary
Documentation Update
chapters/pre-recorded-stt/features/speaker-diarization.mdx
Field name renamed from num_of_speakers to number_of_speakers in diarization configuration documentation, with consistent updates across all references.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • update diarization enhanced config #33: Updates diarization configuration documentation by restructuring enhanced diarization into separate diarization and diarization_config.enhanced fields, related to this PR's field name standardization effort.

Suggested reviewers

  • sboudouk
  • clemos

Poem

🐰 A field name springs from num_of to number_of so clear,
The diarization docs now harmonize without a fear,
One little change, consistency takes the stage—
Documentation blooms anew on every page! 📚✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating documentation to align the diarization config field name with the OpenAPI specification (from num_of_speakers to number_of_speakers).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/diarization-number-of-speakers-doc

No actionable comments were generated in the recent review. 🎉

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants