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

Update doc for MethodLength #11474

Closed
nrmancuso opened this issue Mar 27, 2022 · 7 comments
Closed

Update doc for MethodLength #11474

nrmancuso opened this issue Mar 27, 2022 · 7 comments

Comments

@nrmancuso
Copy link
Member

https://checkstyle.org/config_sizes.html#MethodLength

Add example for each existing config to show what code is ok and what code cause violation.

A good example is https://checkstyle.org/config_naming.html#AbstractClassName.

Look at referenced commits of #5832, to see what and how should be changed in code.

Please play with module/check by means of https://checkstyle.org/cmdline.html to understand how it works.

PLEASE READ https://github.com/checkstyle/checkstyle/wiki/Good-practice-on-how-to-update-examples

@nrmancuso
Copy link
Member Author

nrmancuso commented Mar 27, 2022

We should show in new examples the effect that both block and single line comments have on this check depending on countEmpty property.

@adekzs
Copy link

adekzs commented Apr 2, 2022

Can I work on this

@nrmancuso
Copy link
Member Author

Sure, please leave a comment "I am on it", and send PR. Pay special attention to comment at #11474 (comment) pertaining to changes made at #11312

@adekzs
Copy link

adekzs commented Apr 2, 2022

I am on it

kaungmyat-htet added a commit to kaungmyat-htet/checkstyle that referenced this issue Apr 8, 2022
kaungmyat-htet added a commit to kaungmyat-htet/checkstyle that referenced this issue Apr 8, 2022
kaungmyat-htet added a commit to kaungmyat-htet/checkstyle that referenced this issue Apr 9, 2022
kaungmyat-htet added a commit to kaungmyat-htet/checkstyle that referenced this issue Apr 9, 2022
@Shaman20
Copy link
Contributor

Shaman20 commented Apr 9, 2022

Can I work on this issue?

@romani
Copy link
Member

romani commented Apr 9, 2022

No, there is already PR for this issue Issue #11523

kaungmyat-htet added a commit to kaungmyat-htet/checkstyle that referenced this issue Apr 9, 2022
kaungmyat-htet added a commit to kaungmyat-htet/checkstyle that referenced this issue Apr 9, 2022
kaungmyat-htet added a commit to kaungmyat-htet/checkstyle that referenced this issue Apr 10, 2022
kaungmyat-htet added a commit to kaungmyat-htet/checkstyle that referenced this issue Apr 10, 2022
kaungmyat-htet added a commit to kaungmyat-htet/checkstyle that referenced this issue Apr 10, 2022
kaungmyat-htet added a commit to kaungmyat-htet/checkstyle that referenced this issue Apr 11, 2022
@strkkk strkkk added this to the 10.2 milestone Apr 12, 2022
@strkkk
Copy link
Member

strkkk commented Apr 12, 2022

fix is merged

@strkkk strkkk closed this as completed Apr 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants