Skip to content

Make unstable features explicit with a cargo feature #125

Description

@sunjay

We have things in our API that are unstable. Some examples include:

  • many methods on Drawing
  • everything to do with events

We should make it impossible to use these accidentally by forcing people to use a cargo feature called "unstable". This feature will be disabled by default.

We should make sure that docs.rs still shows these functions and that we have some documentation in each of them to indicate that they shouldn't be used.

One day we might be able to get a working #[unstable] attribute, but until then this will have to do.

  • Mark Event as #[non_exhaustive]
  • Make sure the test feature can't be used without the unstable feature since it isn't part of our stable public API (use the compiler error macro)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions