Tweak how JavaDoc is converted into displayName/description #124
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
timtebeek
commented
Dec 23, 2024
Comment on lines
-85
to
+88
| return "Recipe created for the following Refaster template:\n```java\npublic static class NestedRule {\n \n @BeforeTemplate()\n String before(String s, String s1, String s2) {\n return s.replaceAll(s1, s2);\n }\n \n @AfterTemplate()\n String after(String s, String s1, String s2) {\n return s != null ? s.replaceAll(s1, s2) : s;\n }\n}\n```\n."; | ||
| return "A single line used as description"; |
There was a problem hiding this comment.
This generated block greatly inflates our docs, which hurts readability. Better then to use the JavaDoc provided instead.
jevanlingen
approved these changes
Dec 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What's changed?
Now set either description or displayName + description, but drop the longer generated description where possibe.
What's your motivation?
Previously we would often retain the generated Markdown that merely showed the input template, whereas there's JavaDoc comments that would be a better fit and make the docs more readable.