-
Notifications
You must be signed in to change notification settings - Fork 558
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
Removing support for channel=master
broke Flutter's API docs
#2879
Comments
If there are external uses of the URI-based API, then it should probably be considered an API, with "versioning" and breaking change policies. Seeing it that way would likely have made the transition more explicit and visible:
Since there is only one implementation, "versioning" isn't really the correct word. The version you get is the version that is live today. But explicit breaking changes, with public schedules and deprecations, can still work. |
To note, in relation to this specific case, I think we intended to keep For large changes, I generally verify they don't cause issues for the Flutter API docs locally, but that's not super sustainable. Perhaps we can require a more explicit consideration. |
I'm going to close this for now, since we are aliasing DartPad doesn't have a huge API surface, we support a handful of query parameters for the Gist ID, the theme, and the UI mode (mobile or desktop). We should probably document that better in the embedding guide. I can't think of a way for DartPad to integrate with our documentation tooling to say whether or not a snippet still compiles and runs, but I'm happy to discuss any ideas anyone might have to solve that. |
In Flutter's API docs we are passing
channel=master
as a query param to dart pad to run sample code on themaster
/main
branch. This broke recently whenchannel=master
instead gave us thestable
channel. Instead ofmaster
,main
needs to be passed in now. We are fixing this in flutter/flutter#144329.This breakage went undetected for some time. I am wondering if there is something we can do to avoid breaking Flutter's API docs on these kind of dart pad changes. This issue is meant as a starting point for that discussion.
The text was updated successfully, but these errors were encountered: