-
Notifications
You must be signed in to change notification settings - Fork 6k
Add macros to mark APIs as being deprecated or unavailable. #4401
Conversation
| /** | ||
| CHANGELOG: | ||
| November 29, 2017: Added a CHANGELOG section. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is the changelog useful beyond the git history? In my experience, changelogs are always incomplete and rarely that useful...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is a better place to put just the breaking changes. The engine Git history if full of messages the user of the public API will never care about.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In that case I think we should label this "BREAKING CHANGES", rather than changelog, and we should update the docs for the macros to remind people to add things to this list, and we should update our wiki page to point to this file and say to update it, etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. I am waiting for comments on the doc. But if the suggestions are fine, I will just move it to the wiki.
This contains the macros mentioned in the draft detailing how we could manage breaking changes in the public Flutter engine APIs. The draft is available here.