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

Issue with "bookmarks.export()": Is export a method, an event? Does it even exist? #4863

Closed
gezeta-id opened this issue May 10, 2021 · 1 comment · Fixed by #5513
Closed
Assignees
Labels
Content:WebExt WebExtensions docs

Comments

@gezeta-id
Copy link

MDN URL: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/bookmarks/export

What information was incorrect, unhelpful, or incomplete?

bookmarks.export() is rather suspicious. It's classified as an event on the left sidebar. But then it is presented as a method to be called to export bookmarks. It receives a callback as argument, but then there's no explanation at all about what that callback is for.

A box points to: https://chromium.googlesource.com/chromium/src/+/master/chrome/common/extensions/api/bookmarks.json#418 where it is indeed included as a method an not as an event. But then again, the same box points to https://developer.chrome.com/docs/extensions/reference/bookmarks/#method-export where export is no longer listed, neither as a method nor as an event.

There's also no other mention of export in all of the Bookmarks API section https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/bookmarks at all other than the mentioned appearance in the sidebar.

Should the page https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/bookmarks/export maybe be removed altogether?

Specific section or headline?

The whole page.

What did you expect to see?

Either an event, a method, none at all.

Did you test this? If so, how?

No.

MDN Content page report details
@chrisdavidmills chrisdavidmills added Content:WebExt WebExtensions docs needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels May 10, 2021
@Rob--W Rob--W self-assigned this May 31, 2021
@Rob--W Rob--W removed the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label May 31, 2021
@Rob--W
Copy link
Member

Rob--W commented May 31, 2021

Thanks for the report. I'll remove the section.
See https://bugzilla.mozilla.org/show_bug.cgi?id=1713674 for more context.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Content:WebExt WebExtensions docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants