-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
add description config option for YAML selectors #2800
Comments
gshank
added a commit
that referenced
this issue
Nov 2, 2020
gshank
added a commit
that referenced
this issue
Nov 5, 2020
4 tasks
gshank
added a commit
that referenced
this issue
Nov 6, 2020
gshank
added a commit
that referenced
this issue
Nov 6, 2020
gshank
added a commit
that referenced
this issue
Nov 6, 2020
gshank
added a commit
that referenced
this issue
Nov 6, 2020
gshank
added a commit
that referenced
this issue
Nov 6, 2020
gshank
added a commit
that referenced
this issue
Nov 6, 2020
gshank
added a commit
that referenced
this issue
Nov 6, 2020
gshank
added a commit
that referenced
this issue
Nov 6, 2020
gshank
added a commit
that referenced
this issue
Nov 7, 2020
gshank
added a commit
that referenced
this issue
Nov 8, 2020
gshank
added a commit
that referenced
this issue
Nov 8, 2020
gshank
added a commit
that referenced
this issue
Nov 10, 2020
iknox-fa
pushed a commit
that referenced
this issue
Feb 8, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the feature
It would be nice to have a
description
config property available for YAML selectors. Having it natively supported will allow people to access this metadata in from themanifest.json
file for other use cases, but it will also support surfacing documentation for selectors in the generated docs!Describe alternatives you've considered
We could just add a comment in the
selectors.yml
file, but this won't really allow us to use it anywhere else in the future.Who will this benefit?
This will benefit teams that have complicated run logic as part of their scheduled jobs. It will also help teams working on larger projects that need to be run in groups to be able to cleanly document their selectors right next to the code used.
Are you interested in contributing this feature?
Happy to help write code or to hash this out more!
The text was updated successfully, but these errors were encountered: