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

Mark Experimental API Surfaces #11588

Closed
20 tasks done
AMollis opened this issue May 31, 2023 · 1 comment
Closed
20 tasks done

Mark Experimental API Surfaces #11588

AMollis opened this issue May 31, 2023 · 1 comment

Comments

@AMollis
Copy link
Member

AMollis commented May 31, 2023

This issue has been migrated a new MRTK repository, and the status of this issue will now be tracked at the following location:


Overview

There are numerous APIs we should mark as experimental. We should consider marking these with a "experimental" attribute, similar to how MRTK2 behaved.

Also, for each experimental class, add a "remarks" comment section:

/// <remarks>
/// This is an experimental feature. This class is early in the cycle, it has 
/// been labeled as experimental to indicate that it is still evolving, and 
/// subject to change over time. Parts of the MRTK, such as this class, appear 
/// to have a lot of value even if the details haven’t fully been fleshed out. 
/// For these types of features, we want the community to see them and get 
/// value out of them early enough so to provide feedback. 
/// </remarks>

Parent Task

Tasks

  • Add experimental attribute and drawer
  • Add experimental remarks and attribute to DataBinding types.
    • IDataBindable
    • IDataBindingConfigurator
    • ClassDataBindingProfile
    • DataBindingProfile
    • DataRetrievalMethod
    • ButtonTheme
    • UXThemeProfile
    • CommonTheme
    • HandMenuTheme
    • ListMenuTheme
    • ObjectBarTheme
    • SlateTheme
    • SliderTheme
    • SpriteSetTheme
    • ToggleTheme
    • ect (Search for classes that end in "Theme".... to make sure we get them all)
  • Add experimental remarks and attribute to NonNativeKeyboard.
  • Add experimental remarks and attribute to VirtualizedScrollRectList
@github-actions github-actions bot added the MRTK2 label May 31, 2023
@AMollis AMollis added this to the MRTK v3.0 GA milestone May 31, 2023
@AMollis AMollis added the MRTK3 label May 31, 2023
@AMollis AMollis changed the title Document Experimental API Surfaces Mark Experimental API Surfaces May 31, 2023
@marlenaklein-msft
Copy link
Contributor

Closed with #11630.

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

No branches or pull requests

3 participants