1824630 - TabStateCache documentation/function signatures are misleading

Status: RESOLVED FIXED

(Firefox :: Session Restore, task, P3)

Description

[Shane Hughes [:aminomancer]]

See TabStateCache.sys.mjs: most of the function signatures and code comments refer to the status quo before bug 1703692, where the cache mapped tabs/browsers to tab data. Now, they only accept nsIBrowser::permanentKey instances, but the documentation currently doesn't reflect that (including the lede at the top)

Comment 1

[BugBot [:suhaib / :marco/ :calixte]]

The severity field is not set for this bug.
:dao, could you have a look please?

For more information, please visit auto_nag documentation.

Comment 2

[Sam Foster [:sfoster] (he/him)]

We want to update the language from Retrieves cached data for a given |tab| or associated |browser|. to Retrieves cached data for the tab with the given permanent key.

Comment 3

[Harold Camacho]

Attachment: Bug 1824630 - TabStateCache documentation/function signatures are misleading. r?sfoster

Comment 4

[Harold Camacho]

Hi Sam, I have updated the TabStateCache.sys.mjs file to reflect the abovementioned changes.

Comment 5

[Harold Camacho]

Attachment: Bug 1824630 - TabStateCache documentation/function signatures are misleading. r?sfoster

Comment 6

[Harold Camacho]

Hi Sam, I went ahead and added the indentation to the comment as suggested It now matches the @param above.

Thanks!

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/21d63e247139
TabStateCache documentation/function signatures are misleading. r=sfoster,sessionstore-reviewers

Comment 8

[agoloman]

https://hg.mozilla.org/mozilla-central/rev/21d63e247139