Skip to content

docs: Fix typo in get_camera_video#812

Open
NotBlankyu wants to merge 1 commit into
uilibs:mainfrom
NotBlankyu:patch-1
Open

docs: Fix typo in get_camera_video#812
NotBlankyu wants to merge 1 commit into
uilibs:mainfrom
NotBlankyu:patch-1

Conversation

@NotBlankyu
Copy link
Copy Markdown

@NotBlankyu NotBlankyu commented May 6, 2026

Description of change

Fixes typo wtih -> with

Pull-Request Checklist

  • Code is up-to-date with the main branch
  • This pull request follows the contributing guidelines.
  • This pull request links relevant issues as Fixes #0000
  • There are new or updated unit tests validating the change
  • Documentation has been updated to reflect this change
  • The new commits follow conventions outlined in the conventional commit spec, such as "fix(api): prevent racing of requests".
  • If pre-commit.ci is failing, try pre-commit run -a for further information.
  • If CI / test is failing, try poetry run pytest for further information.

Summary by CodeRabbit

  • Documentation
    • Enhanced documentation for video export settings to clarify timelapse functionality and available frame rate options.

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented May 6, 2026

Merging this PR will not alter performance

✅ 4 untouched benchmarks


Comparing NotBlankyu:patch-1 (4602b4e) with main (4a8177f)

Open in CodSpeed

@codecov
Copy link
Copy Markdown

codecov Bot commented May 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

Files with missing lines Coverage Δ
src/uiprotect/api.py 90.99% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 6, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c608943d-90cd-4cda-97fb-ce12becbeb65

📥 Commits

Reviewing files that changed from the base of the PR and between 4a8177f and 4602b4e.

📒 Files selected for processing (1)
  • src/uiprotect/api.py

📝 Walkthrough

Walkthrough

The PR updates the docstring in the get_camera_video method to clarify that supplying the fps parameter enables timelapse export and to document available FPS options. No functional behavior changes.

Changes

Documentation Clarification

Layer / File(s) Summary
Docstring Update
src/uiprotect/api.py
The get_camera_video docstring is updated to note that the fps parameter creates a timelapse export and to describe supported FPS options.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A doc so clear, a timelapse revealed,
The fps parameter's purpose now sealed.
With words rearranged and wisdom bestowed,
The path for the reviewer is nicely flowed! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'docs: Fix typo in get_camera_video' accurately summarizes the main change: fixing a documentation typo in the get_camera_video method.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Microsoft Presidio Analyzer (2.2.362)
src/uiprotect/api.py

Microsoft Presidio Analyzer failed to scan this file

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

1 participant