search

oppia / oppia-android

A free, online & offline learning platform to make quality education accessible for all.
https://www.oppia.org
Apache License 2.0
315 stars 517 forks source link

Ktlint check comment block #3394

Open anandwana001 opened 3 years ago

anandwana001 commented 3 years ago

Describe the bug Currently, ktlint is not catching the comment block bad format.

/**
 * 
 * 
 * */

Expected behavior Ktlint should catch this bad format.

Correct format

/**
 *
 */
dmdbilal commented 9 months ago

If this still open, Shall i work on this issue ?

adhiamboperes commented 9 months ago

If this still open, Shall i work on this issue ?

Hi @dmdbilal, for the issues that you are interested in, please add a comment with your proposed solution and then we'll assign the issue to you. You can also submit a draft PR containing your preliminary solution. Thanks.

dmdbilal commented 9 months ago

What exactly I need to do in this issue @adhiamboperes ? Whether bad format means the empty lines in the multi-line comments ? or the 2nd asterisk in the last line of the comment ? And If possible can you tell me what's the correct format exactly.

adhiamboperes commented 9 months ago

What exactly I need to do in this issue @adhiamboperes ? Whether bad format means the empty lines in the multi-line comments ? or the 2nd asterisk in the last line of the comment ? And If possible can you tell me what's the correct format exactly.

Hi,

Our code style is based on the Kotlin code style. PTAL at https://kotlinlang.org/docs/kotlin-doc.html. In this case, the issue is referring to the second asterisk in the last line.

adhiamboperes commented 7 months ago

@aadityaguptaa, PTAL.

Vinay-Khanagavi commented 1 week ago

Intresting

manas-yu commented 1 week ago

@adhiamboperes we can create a custom klint rule to resolve this issue. I would like to work on this issue

adhiamboperes commented 1 day ago

@manas-yu, feel free to describe your proposed solution here, then you can put up a PR afterwards.

manas-yu commented 1 day ago

@manas-yu, feel free to describe your proposed solution here, then you can put up a PR afterwards.

We can make custom rules in ktlint https://pinterest.github.io/ktlint/1.0.1/api/custom-rule-set/ so we can add a custom rule to consider this case.

adhiamboperes commented 20 hours ago

@manas-yu, feel free to describe your proposed solution here, then you can put up a PR afterwards.

We can make custom rules in ktlint https://pinterest.github.io/ktlint/1.0.1/api/custom-rule-set/ so we can add a custom rule to consider this case.

Please create a PR for your suggestion.