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

Metadata for pluggable elements #2550

Open
cmdcolin opened this issue Nov 24, 2021 · 2 comments
Open

Metadata for pluggable elements #2550

cmdcolin opened this issue Nov 24, 2021 · 2 comments
Labels
enhancement New feature or request

Comments

@cmdcolin
Copy link
Collaborator

cmdcolin commented Nov 24, 2021

Currently we have parts of our code that may raw list the raw "class name" of different pluggable elements

This includes the:

  1. List of view types when session is empty
  2. List of adapter types and track types when adding tracks
  3. List of display types when toggling display types for a track

the canonical internal name may be familiar to devs and advanced users but inexperienced users may benefit from more human readable names

@cmdcolin cmdcolin added the enhancement New feature or request label Nov 24, 2021
@garrettjstevens
Copy link
Collaborator

A description may also be nice as well

@rbuels rbuels changed the title Human readable names for various pluggable elements? Metadata for pluggable elements Dec 8, 2021
@rbuels
Copy link
Contributor

rbuels commented Dec 8, 2021

Core metadata:

  • displayName - used in menus if present
  • description - used by UI as tooltips or help text

but pluggable elements can add whatever they want in addition to these of course

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants