Skip to content

docs: add usage examples to screen recording methods - #1

Closed
Dor-bl wants to merge 1 commit into
masterfrom
docs/add-usage-screen-record-2440998939312996402
Closed

docs: add usage examples to screen recording methods#1
Dor-bl wants to merge 1 commit into
masterfrom
docs/add-usage-screen-record-2440998939312996402

Conversation

@Dor-bl

@Dor-bl Dor-bl commented Apr 5, 2026

Copy link
Copy Markdown
Owner

Resolves appium#604

This PR adds usage examples to the API documentation for screen recording commands:

  • start_recording_screen
  • stop_recording_screen

This will make it easier for users to understand how to handle the base64 output properly and write it to a media file.


PR created automatically by Jules for task 2440998939312996402 started by @Dor-bl

@google-labs-jules

Copy link
Copy Markdown

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@Dor-bl

Dor-bl commented Jul 11, 2026

Copy link
Copy Markdown
Owner Author

@copilot please fix the merge conflicts in this pull request.

Copilot AI commented Jul 11, 2026

Copy link
Copy Markdown

@copilot please fix the merge conflicts in this pull request.

Merge conflicts resolved in commit 8cb3f87. The conflicts were in CHANGELOG.md, pyproject.toml, and uv.lock — all resolved by taking master's changes. The usage examples in screen_record.py are preserved.

Adds clear usage examples to the docstrings of `start_recording_screen` and `stop_recording_screen` methods in `appium/webdriver/extensions/screen_record.py` demonstrating how to start a recording, stop it, and decode the resulting base64 output into an MP4 file.
@Dor-bl
Dor-bl force-pushed the docs/add-usage-screen-record-2440998939312996402 branch from 8cb3f87 to e097c34 Compare September 5, 2026 07:16
@Dor-bl Dor-bl closed this Sep 6, 2026

Dor-bl commented Sep 6, 2026

Copy link
Copy Markdown
Owner Author

Closing — no longer relevant against upstream (appium/python-client). Upstream just merged #1290 "docs: Add usage examples for screen recording methods", which adds the same Usage: examples for start_recording_screen/stop_recording_screen this PR was proposing (resolving issue appium#604).

Co-Authored-By: Claude Sonnet 5 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_017SqUrtzEQagBh1gXGnjjg4


Generated by Claude Code

@Dor-bl
Dor-bl deleted the docs/add-usage-screen-record-2440998939312996402 branch September 8, 2026 15:10

Dor-bl commented Sep 8, 2026

Copy link
Copy Markdown
Owner Author

Closing: this change is already in upstream appium/python-client as commit 0fe6d91 ("docs: Add usage examples for screen recording methods", appium#1290), released in 6.0.1.

I diffed the hunk in this PR (e097c34) against the upstream commit's change to appium/webdriver/extensions/screen_record.py — they are identical. Merging here would duplicate work already accepted upstream.

The docstrings will arrive in this fork when master is synced with upstream (currently 6 commits behind, through the 6.0.2 tag).


Generated by Claude Code

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.

Need more friendly document

2 participants