1209809 - https://developer.mozilla.org/en-US/Add-ons/Code_snippets/Sidebar suggests using a deprecated method

Status: RESOLVED FIXED

(Developer Documentation Graveyard :: Add-ons, defect)

Description

[Mark Hammond [:markh] [:mhammond]]

https://developer.mozilla.org/en-US/Add-ons/Code_snippets/Sidebar documents addons should use toggleSidebar() to toggle a sidebar. However, this function is defined at https://dxr.mozilla.org/mozilla-central/rev/acdb22976ff86539dc10413c5f366e1fb429a680/browser/base/content/browser-sidebar.js?offset=0#321, which declares it as deprecated and issues a warning when used. The docs should be updated to use the advice in the comment for that function.

Comment 1

[Will Bamberg [:wbamberg]]

I've updated references to toggleSidebar to be about SidebarUI, and checked that the usage examples for this work.

I think that in future add-ons will not get this kind of low-level access to the browser and we will deprecate a lot of these docs, so I don't think it's sensible to spend much more time updating them.