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

Fixes for the IJP Gradle Plugin 2.0 #1301

Merged
merged 6 commits into from
May 28, 2024
Merged

Fixes for the IJP Gradle Plugin 2.0 #1301

merged 6 commits into from
May 28, 2024

Conversation

halirutan
Copy link
Collaborator

@halirutan halirutan commented Apr 17, 2024

Some things to discuss so far:

  • showPaidPluginWarning description does not explain why this is needed. It just explains what it does, which everyone can guess from the name already.
  • Sometimes, we have task descriptions starting as real sentences like "This is a task used to..."; other times, we just write "Prints the list of...". What form should we use consistently?
  • verifyPluginConfiguration Is it correct that this task validates that "The currently selected Java Runtime is not JetBrains Runtime (JBR)"?
  • We are inconsistent and use paragraphs basically as bullet points. E.g. these are not full sentences but they could be one paragraph which I would much prefer. Can we make this consistent?

@karollewandowski
Copy link
Collaborator

karollewandowski commented Apr 19, 2024

My opinion:

showPaidPluginWarning description does not explain why this is needed. It just explains what it does, which everyone can guess from the name already.

+1; it would be nice to explain the purpose.

Sometimes, we have task descriptions starting as real sentences like "This is a task used to..."; other times, we just write "Prints the list of...". What form should we use consistently?

I think we should use more concise form, so "Prints the list..." instead of "This task prints the list...". This style is used in, e.g., method Javadocs, which I think are analogical to task descriptions on our pages.

We are inconsistent and use paragraphs basically as bullet points. E.g. these are not full sentences but they could be one paragraph which I would much prefer. Can we make this consistent?

I don't understand. It looks good to me, but I don't get the lack of the period in the second one.
Could you please provide an example sentence?

OK, started reviewing and see it now. Your version looks better, IMHO.

Copy link
Collaborator

@karollewandowski karollewandowski left a comment

Choose a reason for hiding this comment

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

Looks good to me (two minors).

halirutan and others added 3 commits April 20, 2024 01:54
@YannCebron
Copy link
Member

Please note that some texts need to be synced with kdoc in the plugin itself.

@hsz
Copy link
Member

hsz commented May 28, 2024

Thanks!

@hsz hsz merged commit 96ff7a7 into main May 28, 2024
@hsz hsz deleted the fix_gradle_20_improvements branch May 28, 2024 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants