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

Add recipe descriptors to ApacheCommonsStringUtils #307

Merged
merged 4 commits into from
Oct 2, 2023

Conversation

timtebeek
Copy link
Contributor

@timtebeek timtebeek commented Oct 2, 2023

What's your motivation?

Better documentation once these show up in the docs & platform.

Have you considered any alternatives or workarounds?

  • I think in the past we used the before and after snippets to show document examples.
    That might help to (also) do that to document what these recipes actually replace with.
  • We could also take the detected method (or complete lambda) in the before template and use that to generate the description (only). That would need special handling for recipes with multiple before templates.

@timtebeek timtebeek added the documentation Improvements or additions to documentation label Oct 2, 2023
@timtebeek timtebeek self-assigned this Oct 2, 2023
@okundzich
Copy link
Member

I think in the past we used the before and after snippets to show document examples.
That might help to (also) do that to document what these recipes actually replace with.

That caused various issues and was removed. It was getting examples from tests I believe. Not sure if we can undertake it again anytime soon.

@timtebeek
Copy link
Contributor Author

Yes I wouldn't bring back the exact thing we had, but we still support that format if we write a different processor for before/after templates only. More relevant now that we will start to show the nested recipes.

@jkschneider jkschneider marked this pull request as ready for review October 2, 2023 16:49
@jkschneider jkschneider merged commit 95652b7 into main Oct 2, 2023
1 check failed
@jkschneider jkschneider deleted the add_recipe_descriptors branch October 2, 2023 16:49
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.

3 participants