-
Notifications
You must be signed in to change notification settings - Fork 8
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
Show recipe option example values in table #91
Conversation
See this page for a quick preview: https://openrewrite.github.io/rewrite-recipe-markdown-generator/reference/recipes/java/dependencies/adddependency.html |
Looks like we did show those example values in the Usage yaml, as seen in the current version of the docs: |
We might also want to show |
@timtebeek I see this as a draft PR -- is there anything in particular you're wanting feedback on here? The changes made seem fine to me. |
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.
LGTM - thanks!
What's changed?
Add a fourth options column with example values, as indicated on the option annotations.
What's your motivation?
Helps users see what type of input is expected.
Have you considered any alternatives or workarounds?
We could add the same value to the description instead of a fourth column, as it might be missing frequently.
Any additional context
Reported through OSS Slack:
https://rewriteoss.slack.com/archives/C01A843MWG5/p1702462745389259