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

Show recipe option example values in table #91

Merged
merged 7 commits into from
Dec 13, 2023
Merged

Conversation

timtebeek
Copy link
Contributor

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

@timtebeek timtebeek added the documentation Improvements or additions to documentation label Dec 13, 2023
@timtebeek timtebeek self-assigned this Dec 13, 2023
@timtebeek
Copy link
Contributor Author

@timtebeek timtebeek changed the title Show recipe option example values Show recipe option example values in table Dec 13, 2023
@timtebeek
Copy link
Contributor Author

Looks like we did show those example values in the Usage yaml, as seen in the current version of the docs:
https://docs.openrewrite.org/recipes/maven/adddependency

@timtebeek
Copy link
Contributor Author

@timtebeek timtebeek marked this pull request as draft December 13, 2023 13:34
@mike-solomon
Copy link
Contributor

@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.

@timtebeek timtebeek marked this pull request as ready for review December 13, 2023 17:23
Copy link
Contributor

@mike-solomon mike-solomon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - thanks!

@timtebeek timtebeek merged commit a7d922e into main Dec 13, 2023
1 check passed
@timtebeek timtebeek deleted the show-option-examples branch December 13, 2023 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants