docs(client): update client configuration parameters

[0x676e67]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @0x676e67, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request primarily focuses on enhancing the documentation for the client's configuration parameters by updating the docstrings within the ClientConfig TypedDict. The changes aim to provide more comprehensive and clearer explanations for various settings, such as network options, timeout behaviors, HTTP/TLS protocols, proxy management, and content decompression, thereby improving the overall understanding and usability of the client's configuration for developers.

Highlights

• Enhanced Documentation for Client Configuration: Numerous docstrings for ClientConfig parameters have been updated to provide more precise descriptions, including default values, specific behaviors, and the headers they affect.
• Detailed Network and Timeout Explanations: The documentation for TCP options (e.g., tcp_keepalive, tcp_user_timeout), connection pooling (pool_idle_timeout, pool_max_idle_per_host), and network binding (interface, local_address) has been significantly expanded for clarity.
• Clarified HTTP/TLS and Proxy Settings: Descriptions for HTTP version enforcement (http1_only, http2_only), HTTPS restriction (https_only), TLS certificate verification (verify), and proxy configuration (no_proxy, proxies) have been improved.
• Decompression Option Behavior: The docstrings for automatic content decompression settings (gzip, brotli, deflate, zstd) now explicitly state that they operate by checking the Content-Encoding response header.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request updates the documentation for the client configuration parameters in python/rnet/__init__.pyi, making them more descriptive and informative. The changes are generally positive, but I've identified a minor typo and a significant copy-paste error in the new docstrings that should be addressed to ensure accuracy.

[Copilot]

Pull request overview

This PR updates the documentation for client configuration parameters in the type stub file, making descriptions more clear, comprehensive, and consistent. The changes improve the developer experience by providing more detailed explanations of what each configuration option does.

Key Changes

• Enhanced documentation for timeout, TCP, connection pool, HTTP, TLS, network, and compression configuration options
• Added detailed explanations with default values and behavioral descriptions
• Improved consistency in documentation style across all configuration parameters

Reviewed changes

Copilot reviewed 1 out of 2 changed files in this pull request and generated 2 comments.

File	Description
tests/tls_test.py	Removed trailing whitespace from lines 26 and 29
python/rnet/init.pyi	Updated documentation strings for ClientConfig parameters with more detailed and consistent descriptions, including default values and behavioral explanations

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

There's an extra space before "IPV6_BOUND_IF" on this line. The indentation should be consistent with the rest of the documentation. The line should start with 4 spaces (matching the rest of the docstring), not 5.

Suggested change

	systems, Solaris, and illumos, this instead uses the [`IP_BOUND_IF` and
	`IPV6_BOUND_IF`][man-7p-ip] socket options (as appropriate).
	systems, Solaris, and illumos, this instead uses the [`IP_BOUND_IF` and
	`IPV6_BOUND_IF`][man-7p-ip] socket options (as appropriate).

[0x676e67]

@copilot open a new pull request to apply changes based on the comments in this thread

[Copilot]

@0x676e67 I've opened a new pull request, #483, to work on those changes. Once the pull request is ready, I'll request review from you.

[Copilot]

Pull request overview

Copilot reviewed 1 out of 2 changed files in this pull request and generated no new comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.