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

Align managed storage snippet with favorite color example #20254

Merged

Conversation

rebloor
Copy link
Contributor

@rebloor rebloor commented Sep 2, 2022

Summary

The favourite-colour example web extension uses British English e.g. favourite and colour. The instructions for using the example include details on how to create the manage storage file but also point the reader to storage.managed where the example of the manage storage file is presented in American English e.g. favorite and color. This may be causing issues if the reader uses the storage.managed file version to create the file.

Motivation

To avoid potential issues with the example extension not working if the user copeis the file content from storage.managed.

Supporting details

This issue appears to have occurred in Favourite Color bug manifest #498

Metadata

This PR…

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

@rebloor rebloor added the Content:WebExt WebExtensions docs label Sep 2, 2022
@rebloor rebloor requested a review from Rob--W September 2, 2022 18:00
@rebloor rebloor self-assigned this Sep 2, 2022
@rebloor rebloor requested a review from a team as a code owner September 2, 2022 18:00
@github-actions github-actions bot added the Content:Other Any docs not covered by another "Content:" label label Sep 2, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Sep 2, 2022

Preview URLs

Flaws

None! 🎉

External URLs

URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/API/storage/managed
Title: storage.managed
on GitHub

No new external URLs

(this comment was updated 2022-09-07 21:57:30.886659)

}
}
```

Given this manifest, the "favorite-color-examples\@mozilla.org" extension could access the data using code like this:
Given this manifest, the ["favourite-colour-examples\@mozilla.org"](https://github.com/mdn/webextensions-examples/tree/master/favourite-colour) extension accesses the data using code like this:
Copy link
Member

Choose a reason for hiding this comment

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

"could access" is still accurate. The code snippet below does not appear in that extension.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point, reverted

}
}
```

Given this manifest, the "favorite-color-examples\@mozilla.org" extension could access the data using code like this:
Given this manifest, the ["favourite-colour-examples\@mozilla.org"](https://github.com/mdn/webextensions-examples/tree/master/favourite-colour) extension accesses the data using code like this:
Copy link
Member

Choose a reason for hiding this comment

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

Is the \ before @ needed? If not, let's remove it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I changed this just to represent the extension name

@rebloor rebloor requested a review from Rob--W September 7, 2022 21:56
@rebloor rebloor merged commit e106177 into mdn:main Sep 8, 2022
@rebloor rebloor deleted the Align-favorite-color-manage-storage-file-content branch September 8, 2022 16:56
himanshugarg pushed a commit to himanshugarg/content that referenced this pull request Sep 27, 2022
* Align managed storage snippet with favorite color example

* Addressed feedback

* Removed space
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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