Bug 263967 - Incorrect documentation for webkit-cookie-manager-get-cookies-finish
Summary: Incorrect documentation for webkit-cookie-manager-get-cookies-finish
Status: RESOLVED FIXED
Alias: None
Product: WebKit
Classification: Unclassified
Component: WebKitGTK (show other bugs)
Version: WebKit Nightly Build
Hardware: Unspecified Unspecified
: P2 Normal
Assignee: Michael Catanzaro
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-10-31 07:52 PDT by SyntevoAlex
Modified: 2023-11-01 09:21 PDT (History)
2 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description SyntevoAlex 2023-10-31 07:52:26 PDT 
These two functions:
* webkit_cookie_manager_get_cookies_finish
* webkit_cookie_manager_get_all_cookies_finish

are incorrectly documented to "return value is a #GSList", whereas it actually returns GList.
This is not a mere typo, because GSList is also an existing type.

The incorrect documentation existed ever since the code was introduced in e07cfc0d.

This actually fooled some people, see for example:
https://github.com/eclipse-platform/eclipse.platform.swt/issues/842
Comment 1 Michael Catanzaro 2023-10-31 10:30:13 PDT 
Thanks for reporting this.
Comment 2 Michael Catanzaro 2023-10-31 10:37:10 PDT 
Pull request: https://github.com/WebKit/WebKit/pull/19782
Comment 3 EWS 2023-11-01 09:21:15 PDT 
Committed 270058@main (e57b85e56c4c): <https://commits.webkit.org/270058@main>

Reviewed commits have been landed. Closing PR #19782 and removing active labels.