Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Eclipse/API Central/Deprecation Policy"
< Eclipse | API Central
(→References) |
(→What is Deprecation?) |
||
| Line 3: | Line 3: | ||
= What is Deprecation? = | = What is Deprecation? = | ||
| − | Despite our best efforts, we don't always craft API that remains perfect forever. Often new and better approaches come along that supersede old ways of doing things. API deprecation is used to inform API clients that a particular API element is no longer recommended. The deprecation comment should describe the reason for the deprecation, and directions for how to replace their usage with the new recommended way of doing things. | + | Despite our best efforts, we don't always craft API that remains perfect forever. Often new and better approaches come along that supersede old ways of doing things. API deprecation is used to inform API clients that a particular API element is no longer recommended. The deprecation comment should describe the reason for the deprecation, and directions for how to replace their usage with the new recommended way of doing things. Valid reasons for deprecating API may include: |
| + | * The old API contract requires the implementation to be buggy, inefficient, or unable to handle all possible use cases | ||
| + | * The old API has been, or will be, deleted in a later release | ||
| + | * The old API is redundant, duplicating functionality available elsewhere | ||
= Identifying Deprecated API = | = Identifying Deprecated API = | ||
Revision as of 10:58, 23 October 2009
This page contains draft Eclipse Project guidelines on API deprecation.
Contents
What is Deprecation?
Despite our best efforts, we don't always craft API that remains perfect forever. Often new and better approaches come along that supersede old ways of doing things. API deprecation is used to inform API clients that a particular API element is no longer recommended. The deprecation comment should describe the reason for the deprecation, and directions for how to replace their usage with the new recommended way of doing things. Valid reasons for deprecating API may include:
- The old API contract requires the implementation to be buggy, inefficient, or unable to handle all possible use cases
- The old API has been, or will be, deleted in a later release
- The old API is redundant, duplicating functionality available elsewhere