Bug 131793 - [CheatSheet] Make composite cheat sheet API provisional
Summary: [CheatSheet] Make composite cheat sheet API provisional
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: User Assistance (show other bugs)
Version: 3.2   Edit
Hardware: PC Windows XP
: P3 major (vote)
Target Milestone: 3.2 M6   Edit
Assignee: platform-ua-inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords: api
Depends on:
Blocks:
 
Reported: 2006-03-14 14:53 EST by Chris Goldthorpe CLA
Modified: 2006-03-16 09:22 EST (History)
1 user (show)

See Also:


Attachments
Proposed patch (65.27 KB, patch)
2006-03-15 14:45 EST, Chris Goldthorpe CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Chris Goldthorpe CLA 2006-03-14 14:53:26 EST
Composite cheat sheets added four interfaces and 2 classes to the API. These should be made provisional to allow them time to mature before they are frozen in API.

The classes/interfaces are:

ICompositeCheatSheet
ICompositeCheatSheetTask
IEditableTask
ITaskGroup
TaskEditor
TaskExplorer
Comment 1 Dejan Glozic CLA 2006-03-14 14:58:22 EST
Chris, here is the official Eclipse policy on provisional APIs:

http://wiki.eclipse.org/index.php/Provisional_API_Guidelines
Comment 2 Chris Goldthorpe CLA 2006-03-15 14:45:58 EST
Created attachment 36355 [details]
Proposed patch

Those four interfaces and two classes have been moved to org.eclipse.ui.internal.provisional.cheatsheets.
Comment 3 Curtis d'Entremont CLA 2006-03-15 15:28:51 EST
Applied.
Comment 4 John Arthorne CLA 2006-03-15 18:34:55 EST
Sorry to be a pain, but moving the API types into an internal package is also an API change since this API existed at the time of the API freeze.  However, this definitely sounds like the right answer if you want more time to evolve it.  I assume there are no known clients of this API yet?
Comment 5 Chris Goldthorpe CLA 2006-03-15 19:53:47 EST
Yes there are no clients. Sorry about the confusion, I thought that this change had already been approved at least verbally.
Comment 6 Mike Wilson CLA 2006-03-16 09:07:58 EST
If we are unsure about the maturity of the interfaces and there are no clients, then it clearly should not be API. +1 to marking it provisional, ok to proceed.
Comment 7 Dejan Glozic CLA 2006-03-16 09:22:09 EST
We beleive that APIs are close to maturity, but since they are built for potential future clients as opposed to real ones today, we feel better making it provisional today and working with future clients on shaping the interfaces towards final APIs.