search

OpenF2 / F2

Redefining web integration for the financial services community
Apache License 2.0
129 stars 62 forks source link

Deprecate methods that replace browser features #213

Closed montlebalm closed 9 years ago

montlebalm commented 9 years ago

As an F2 developer, I want to deprecate F2.inArray, F2.parse, F2.stringify because F2 does not need to replace existing browser features.

Checking for the existence of an item in an array is a standard function in all modern browsers and IE9+. This kind of syntactic sugar is also supplied by jQuery, underscore, lodash, and most other convenience libraries.

The standard JSON functions of parse and stringify are present in all browsers supported by F2.

I recommend marking these as "Depreciated" in the docs for one point release before removing them to allow developers time to transition. We can change, then remove between 1.4 --> 1.5 or 1.5 --> 1.6.

markhealey commented 9 years ago

:+1:

markhealey commented 9 years ago

Carrying the conversation from Slack over here, merging #217 as-is would violate SemVer and so will need to mark features as deprecated without removing them entirely. See @deprecated yuidoc tagging example for the docs here.