615164 - rename Tab.pinned to isPinned, make read-only, and add pin()/unpin() methods

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: General, defect)

Description

[Myk Melez [:myk] [@mykmelez]]

For consistency with API conventions for boolean properties and recent changes away from the use of setters for side effects, the "pinned" property of tabs should be renamed "isPinned", it should become read-only, and pin() and unpin() methods should be added to replace the behavior of setting the property.

This should block the beta because of the difficulty of changing the behavior afterwards.

Comment 1

[Irakli Gozalishvili [:irakli] [:gozala] [@gozala]]

Attachment: https://github.com/mozilla/addon-sdk/pull/56

Still think that pinned had advantage of simpler toggling API:

    tab.pinned = !tab.pinned

vs

    if (tab.isPinned) tab.unpin()
    else tab.pin()

Comment 2

[Myk Melez [:myk] [@mykmelez]]

Yes, toggling is simpler with the old API, but you can still toggle in one statement with the new one:

  tab.isPinned ? tab.unpin() : tab.pin()

Comment 3

[Dietrich Ayala (:dietrich)]

Comment on attachment 493660 [details] [diff] [review]
https://github.com/mozilla/addon-sdk/pull/56

r=me, thanks for adding the doc clarifications.