Clarify get_cookies() return value in documentation#80
Merged
Conversation
oalders
force-pushed
the
fix-get-cookies-doc
branch
from
bdc01da to
5663ba1
Compare
get_cookies() returns a hash reference (not a hash) when called without
cookie keys. Correct the POD to say so, and fix subject/verb agreement
("cookies that apply").
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
oalders
force-pushed
the
fix-get-cookies-doc
branch
from
5663ba1 to
04fd77f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
get_cookies()returns a hash reference (not a hash) when called without$cookie_keyarguments — it returns the$cookieshashref built in the method body. The POD said "Returns a hash of the cookies", which is inaccurate.This corrects the wording to "Returns a reference to a hash of the cookies that apply to the given URL" and fixes the subject/verb agreement (
applies→apply).Note
This is a follow-up to #75 (merged). The wording corrected here is not present on the current
master, so this PR (re)applies the documentation improvement along with the grammar fix.🤖 Generated with Claude Code