Skip to content

Update HTTPCookiePropertyKey.path comment #932

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 12, 2017
Merged

Update HTTPCookiePropertyKey.path comment #932

merged 1 commit into from
Apr 12, 2017

Conversation

DunnCoding
Copy link
Contributor

This PR is relating to SR-3821

The comment seems to suggest that supplying a value for path is optional and if a value isn't provided it'll either infer from HTTPCookiePropertyKey.originURL or use a default of "/". None of those seem to be the case though, and HTTPCookie([...]) will return nil if you haven't provided a value for path.

Tracked down some documentation to support this as well.

@pushkarnk
Copy link
Member

The code comments that are the subject here don't seem to be consumed in any online documentation , neither in HTTPCookie.init(properties:) nor HTTPCookiePropertyKey. I wonder if we need those HTML tags anymore. May be we should do away with them too?

@pushkarnk
Copy link
Member

I'll merge this since it addresses the SR. But we should revisit the code comments in question to check if we could do more of a cleanup. Thanks!

@swift-ci test and merge

@pushkarnk
Copy link
Member

@swift-ci test and merge

@swift-ci swift-ci merged commit de6ff76 into swiftlang:master Apr 12, 2017
@DunnCoding DunnCoding deleted the cookiePathComment branch April 21, 2017 13:05
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.

3 participants