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.

Sign up for GitHub

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

Jump to bottom

Extract display name and description from JavaDoc #51

Merged
merged 7 commits into from
Dec 17, 2023
Merged

Extract display name and description from JavaDoc #51

merged 7 commits into from
Dec 17, 2023

Conversation

timtebeek
Copy link
Contributor

@timtebeek timtebeek self-assigned this Dec 17, 2023
@Stephan202 Stephan202 mentioned this pull request Dec 17, 2023
Merged
Stephan202
Stephan202 reviewed Dec 17, 2023
View reviewed changes
Copy link
Contributor

@Stephan202 Stephan202 left a comment

Choose a reason for hiding this comment

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

Nice! Within Error Prone Support we currently have similar functionality using an @Description annotation, but I have pondered in the past whether indeed we should instead just look at the Javadoc. So this change SGTM!

src/main/java/org/openrewrite/java/template/processor/RefasterTemplateProcessor.java Outdated Show resolved Hide resolved
@timtebeek
Copy link
Contributor Author

Nice! Within Error Prone Support we currently have similar functionality using an @Description annotation, but I have pondered in the past whether indeed we should instead just look at the Javadoc. So this change SGTM!

Ah interesting! Had been looking for something like that on your end, but didn't immediately spot anything. I only see that @tech.picnic.errorprone.refaster.annotation.Description applied twice though, once in tests. I'm guessing you're considering just taking the JavaDoc there as well then?

@timtebeek timtebeek merged commit 626b74f into main Dec 17, 2023
1 check passed
@timtebeek timtebeek deleted the extract-display-name-and-description-from-docs branch December 17, 2023 21:21
@Stephan202
Copy link
Contributor

I'm guessing you're considering just taking the JavaDoc there as well then?

Nothing decided, but at this point it seems likely: the JavaDoc seems more maintainable and easy to use, especially when considering line wrapping.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Stephan202 Stephan202 Stephan202 left review comments

@knutwannheden knutwannheden Awaiting requested review from knutwannheden

Assignees

@timtebeek timtebeek

Labels
None yet
Projects
OpenRewrite
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@timtebeek @Stephan202