Skip to content
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

WebExtensions: Fix conflicting behavior explanation across browsers for "homepage_url" and "developer.url". #9950

Merged
merged 2 commits into from
Oct 24, 2021

Conversation

carlosjeurissen
Copy link
Contributor

Fix conflicting behavior explanation across browsers for "homepage_url" and "developer.url".

Summary

Better explained the behavior of conflicting homepage_url with developer.url in manifest.json of webExtensions.

Motivation

Fix untrue statement about conflicting behavior in Opera.

Supporting details

The Opera behavior has been tested in the latest Opera Desktop version. While the behavior in Firefox has been taken from what was already mentioned in MDN.

This PR…

  • Adds a new document
  • Rewrites (or significantly expands) a document
  • Fixes a typo, bug, or other error

Fix conflicting behavior explanation across browsers for "homepage_url" and "developer.url".
@carlosjeurissen carlosjeurissen requested a review from a team as a code owner October 20, 2021 10:04
@carlosjeurissen carlosjeurissen requested review from rebloor and removed request for a team October 20, 2021 10:04
@github-actions github-actions bot added Content:Other Any docs not covered by another "Content:" label Content:WebExt WebExtensions docs labels Oct 20, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Oct 20, 2021

Preview URLs

Flaws

None! 🎉

External URLs

URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/homepage_url
Title: homepage_url
on GitHub

No new external URLs

(this comment was updated 2021-10-24 15:51:20.612638)

Copy link
Contributor

@rebloor rebloor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The suggestion to tighten the wording

@@ -31,7 +31,7 @@

<p>URL for the extension's home page.</p>

<p>If the <a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/developer">developer</a> key is supplied and it contains the "url" property, this will override the homepage_url key.</p>
<p>If both <a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/developer">developer</a> key is supplied and it contains the "url" property and "homepage_url" is defined. Mozilla Firefox will favor "developer.url" while Opera favors "homepage_url".</p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am wondering whether "favor" is to open to interpretation:
<p>If a <a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/developer">developer</a> key containing the "url" property and "homepage_url" are defined, Mozilla Firefox uses "developer.url" while Opera uses "homepage_url".</p>
And, are we covered for the behavior in Chrome?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Google Chrome doesn't support the developer property so no conflicts appear. As for the favor, we can specify it uses one over the other instead of favor. Tho both are true. If they use it they actually favor them as well. Happy with the edit you are proposing! Not sure what the behavior is on Apple Safari.

Relevant link:
w3c/webextensions#67

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@carlosjeurissen As we are preparing to convert to markdown I've gone ahead, made the changes and merged, many thanks for your help.

Clarifying "favor" and adding a note regarding Chrome and Safari
@rebloor rebloor merged commit abb287e into mdn:main Oct 24, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 24, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Content:Other Any docs not covered by another "Content:" label Content:WebExt WebExtensions docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants