docs(cookie): fix compression parameter type in cookie constructor

[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 refines the Jar class constructor by correcting the type annotation for its compression parameter. The parameter's type has been changed from an optional integer (representing a compression level) to an optional boolean, indicating a simple on/off state for compression. Correspondingly, the associated docstring has been updated to reflect this change, ensuring accuracy and clarity for developers.

Highlights

• Type Hint Correction: The type hint for the compression parameter in the Jar class constructor (__init__) has been updated from int | None to bool | None.
• Docstring Refinement: The outdated Args documentation for the compression parameter, which incorrectly described it as an 'Optional compression level,' has been removed to align with its new boolean type.

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 correctly fixes the type hint for the compression parameter in the Jar constructor from int | None to bool | None. However, in the process, the documentation for this parameter was removed from the docstring. I've added a suggestion to restore the parameter's documentation with an updated description that reflects its new boolean type, ensuring the method's signature remains clear and well-documented.

[gemini-code-assist]

While the type hint for compression is now correct, the docstring no longer documents this parameter. It's important to document all parameters to maintain code clarity.

Please consider re-adding the Args section to explain what the compression parameter does, reflecting its boolean nature.

        r"""Create a new cookie jar with compression enabled by default.

        Args:
            compression: Whether to enable compression for the cookie jar.
                If `True` or `None` (default), compression is enabled.
                If `False`, compression is disabled.
        """