Skip to content

docs(cookie): update get method argument description for clarity#566

Merged
0x676e67 merged 2 commits intomainfrom
cookie
Apr 14, 2026
Merged

docs(cookie): update get method argument description for clarity#566
0x676e67 merged 2 commits intomainfrom
cookie

Conversation

@0x676e67
Copy link
Copy Markdown
Owner

@0x676e67 0x676e67 commented Apr 14, 2026

Summary by CodeRabbit

  • Documentation
    • Clarified cookie lookup behavior: docs now state cookie domain matching requires an exact domain match (no subdomain matches) and retain path matching details.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 14, 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: e272f108-3897-4094-baa9-c87266a0daf7

📥 Commits

Reviewing files that changed from the base of the PR and between a93fc11 and 7582398.

📒 Files selected for processing (1)
  • python/wreq/cookie.py
✅ Files skipped from review due to trivial changes (1)
  • python/wreq/cookie.py

📝 Walkthrough

Walkthrough

Updated the Jar.get() docstring in python/wreq/cookie.py to explicitly document cookie domain-scoping behavior: domain matching requires exact equality with the URL host, and subdomains are not considered.

Changes

Cohort / File(s) Summary
Documentation Update
python/wreq/cookie.py
Clarified Jar.get() docstring to specify exact domain matching for cookie lookup and that subdomains are excluded; narrowed url parameter description accordingly.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I hopped through lines of code today,

Cleared cookie rules along the way,
Exact domains now take the stage,
No subdomain mischief on the page,
🍪✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating documentation for the get method's argument in the cookie module for clarity.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✏️ 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 cookie

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 for the get method in python/wreq/cookie.py to clarify that domain matching is exact and does not include subdomains. A review comment suggests refining the description of the url parameter to avoid ambiguity regarding path matching, which is typically prefix-based rather than exact.

Comment thread python/wreq/cookie.py Outdated
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@0x676e67 0x676e67 changed the title docs(cookie): update get method argument description for clarity docs(cookie): update get method argument description for clarity Apr 14, 2026
@0x676e67 0x676e67 merged commit 1b20aca into main Apr 14, 2026
1 check passed
@0x676e67 0x676e67 deleted the cookie branch April 14, 2026 11:11
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