-
Notifications
You must be signed in to change notification settings - Fork 121
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 configuration field inline docs #430
Conversation
e18f9b4
to
8144663
Compare
Signed-off-by: Josh Wolf <josh@wolfs.io>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is amazing to have!! Thanks for raising the bar for us!
// Optional: The map of security fixes for this package keyed by the version | ||
// found | ||
Secfixes Secfixes `yaml:"secfixes,omitempty"` | ||
// Optional: The map of advisories for this package | ||
Advisories Advisories `yaml:"advisories,omitempty"` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No change requested, just mentioning in case it impacts your plans at all: we'll be these fields soon, along with the related secfixes/advisory types below.
Signed-off-by: Josh Wolf <josh@wolfs.io>
add struct field inline docs for configuration structs, for use (eventually) by some external docs parser like the one here