2066478 - Update comments that point at the removed openUILinkIn function

Status: RESOLVED FIXED

(Firefox :: Address Bar, task)

Description

[Dão Gottwald [:dao]]

Filing as a good first bug to learn workflows.

There is no openUILinkIn function any more, but six comments still send the reader there for the list of supported parameters. The function that takes those parameters today is URILoadingHelper.openLinkIn, exposed on a browser window as openLinkIn; openUILink is the variant that derives where to open from an event's modifiers.

Each of those comments should name the function the surrounding code actually calls, and point at browser/modules/URILoadingHelper.sys.mjs, which is where the parameters are documented.

The comments to update are in four files, and this search lists them:
https://searchfox.org/firefox-main/search?q=openUILinkIn&case=false&path=

• browser/components/urlbar/content/UrlbarInputBase.mjs
• browser/components/urlbar/content/SmartbarInput.mjs
• browser/actors/ContentSearchParent.sys.mjs
• devtools/client/shared/link.js (three of them)

Or from a checkout:

rg openUILinkIn browser/ devtools/

To verify the fix, that same command should report nothing. Two further mentions are out of scope: a test manifest tag in browser/components/sessionstore/test/browser.toml, and a comment in toolkit/components/messaging-system/schemas/SpecialMessageActionSchemas/index.md.

Tutorial to contribute:
https://firefox-source-docs.mozilla.org/contributing/contribution_quickref.html
https://firefox-source-docs.mozilla.org/contributing/stack_quickref.html

Please do not ask for the bug to be assigned. It will be automatically assigned to the first patch.

Comment 1

[BugBot [:suhaib / :marco]]

The Bugbug bot thinks this bug should belong to the 'Firefox::Address Bar' component, and is moving the bug to that component. Please correct in case you think the bot is wrong.

Comment 2

[Amadi]

Attachment: Bug 2066478 - Remove stale references to openUILinkIn in comments. r=#urlbar-reviewers

There is no openUILinkIn function any more, but six comments still send the reader there
for the list of supported parameters. The function that takes those parameters today is
URILoadingHelper.openLinkIn, exposed on a browser window as openLinkIn; openUILink is
the variant that derives where to open from an event's modifiers.

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/a8e25fc925a2
https://hg.mozilla.org/integration/autoland/rev/45c0f30ef679
Remove stale references to openUILinkIn in comments. r=urlbar-reviewers,devtools-reviewers,ochameau,dao DONTBUILD

Comment 4

[Cristian Tuns]

https://hg.mozilla.org/mozilla-central/rev/45c0f30ef679