Skip to content

docs(guide): fix examples#573

Merged
0x676e67 merged 1 commit intomainfrom
chore
Apr 15, 2026
Merged

docs(guide): fix examples#573
0x676e67 merged 1 commit intomainfrom
chore

Conversation

@0x676e67
Copy link
Copy Markdown
Owner

@0x676e67 0x676e67 commented Apr 15, 2026

Summary by CodeRabbit

Documentation

  • Revised proxy configuration guide with updated API examples and usage patterns for SOCKS5 proxies and per-request configurations
  • Updated WebSocket connection guide with corrected parameter naming for TLS verification settings
  • Improved documentation structure by removing duplicate sections and tables

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 15, 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: 1efcb4f7-9682-4dc7-973b-585024a65724

📥 Commits

Reviewing files that changed from the base of the PR and between e0cc1fd and 734a68f.

📒 Files selected for processing (3)
  • docs/source/guide/proxy.md
  • docs/source/guide/websocket.md
  • tests/multipart_test.py

📝 Walkthrough

Walkthrough

Documentation updates for proxy and WebSocket usage examples, including API shape changes for SOCKS5 proxies, parameter name updates from proxies= to proxy= in per-request examples, and removal of a duplicated documentation section. Also includes minor test formatting.

Changes

Cohort / File(s) Summary
Documentation Updates
docs/source/guide/proxy.md, docs/source/guide/websocket.md
Updated proxy examples to use Proxy.all(...) for SOCKS5, changed per-request proxy parameter from proxies=[...] to proxy=..., removed duplicated section; updated WebSocket client from verify=False to tls_verify=False.
Test Formatting
tests/multipart_test.py
Reformatted Part construction in test_reuse_multipart_with_clonable_parts to use multi-line argument layout without functional changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰 The docs have learned to hop more true,
With proxy paths both fresh and new,
And websockets sing in clearer tune,
While tests stand neat beneath the moon! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs(guide): fix examples' clearly and specifically summarizes the main change: fixing documentation examples in the guide section.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore

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.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation and test files to align with API changes. Key modifications include updating proxy configuration examples to use the "proxy" parameter instead of "proxies", switching to "Proxy.all" for SOCKS5 examples, and renaming the "verify" parameter to "tls_verify" in the WebSocket guide. Additionally, minor reformatting was applied to the multipart test. I have no feedback to provide.

@0x676e67 0x676e67 merged commit 2ed6f08 into main Apr 15, 2026
32 checks passed
@0x676e67 0x676e67 deleted the chore branch April 15, 2026 00:46
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