Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Controlled deprecation, with tool support #972

Closed
DavidWhaleMEF opened this issue Jul 26, 2018 · 2 comments
Closed

Controlled deprecation, with tool support #972

DavidWhaleMEF opened this issue Jul 26, 2018 · 2 comments

Comments

@DavidWhaleMEF
Copy link

Is your feature request related to a problem? Please describe.
When breaking changes have to be done to the language or API's (e.g. in order to correct previous errors such as 'pressed' and 'clicked'), this stores up errors for the future. A teacher that has a pre-written exercise, perhaps with a working hex file, drags the hex file into a later editor and now it comes up with an error

Describe the solution you'd like
When breaking changes need to be made to API's and the language (for good reasons, to support innovation and progress), leave the API method present and mark it as deprecated. If a script uses a deprecated API call, there should be some warning that pops up, with a way for users to get advice on the new way to do things. After, say, 1 major release with deprecation, the next major release could remove the old API but leave the deprecation hints. A further major release could then remove these phantom deprecation hints as a way to spring clean.

Describe alternatives you've considered
An alternative is to never change or delete API methods (e.g CreateFile and CreateFileEx in the windows API is an example of this).

Additional context
It was thinking about this issue and @abchatra 's reply about making a breaking change, that reminded me of how the java language very elegantly has a process to manage deprecation in a controlled and visible way.
#963

@abchatra
Copy link
Collaborator

Yes we do that already. We deprecate the API, but still available if you drag the old hex file.

@lock
Copy link

lock bot commented Sep 26, 2019

This thread has been automatically locked since there has not been
any recent activity after it was closed. Please open a new issue for
related bugs.

@lock lock bot locked as resolved and limited conversation to collaborators Sep 26, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants