openrewrite / rewrite-templating

Automated templating using code snippets.
Apache License 2.0
16 stars 7 forks source link

Additional cleanup for error-prone descriptions #93

Open Philzen opened 3 months ago

Philzen commented 3 months ago

Following the discussion in https://github.com/openrewrite/rewrite-docs/pull/282

The error-prone template descriptions by picnic seem to need some more treatment. See this example for https://docs.openrewrite.org/recipes/tech/picnic/errorprone/refasterrules/testngtoassertjrulesrecipes:

grafik

TODOs:

https://github.com/openrewrite/rewrite-docs/pull/282/commits/5925d43b8d3816a6df73ad9b820b49425f1807e8 sort of already describes a good test case.

timtebeek commented 3 months ago

Thanks for logging the issue separately; providing the context & links from the other issue for quick reference:

All in all this will require some fixes both here and in the markdown generator, before they show up as fixed in the docs.