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

documentation of VariableDeclarationUsageDistance has stange note of default distance #9219

Closed
romani opened this issue Jan 30, 2021 · 4 comments
Closed

documentation of VariableDeclarationUsageDistance has stange note of default distance #9219

romani opened this issue Jan 30, 2021 · 4 comments
Labels
approved miscellaneous
Milestone
8.41

Comments

@romani
Copy link
Member

romani commented Jan 30, 2021

https://checkstyle.org/config_coding.html#VariableDeclarationUsageDistance_Notes

As distance by default is 1 the ....

As the distance is more than the default one, ....

default allowedDistance is 3 https://checkstyle.org/config_coding.html#VariableDeclarationUsageDistance_Properties

it is not clear what doc mean, or it might be outdated.
@romani
Copy link
Member Author

romani commented Jan 30, 2021

@bossever , please help to resolve this issue, it was detected during review of #9215

@bossever
Copy link
Contributor

bossever commented Jan 31, 2021 •
edited
Loading

@romani, after checking the examples in Unsupported Cases I think the check is working exactly as intended, this section seems to be outdated. I think it can be safely removed so that it does not confuse the user about the working of the check. I have provided examples in PR.

bossever added a commit to bossever/checkstyle that referenced this issue Jan 31, 2021
@bossever
Issue checkstyle#9219: Removed redundant \"Unsupported cases\" sectio…
6e72698 
…n from VariableDeclarationUsageDistance check documentation
@bossever bossever mentioned this issue Jan 31, 2021
Merged
@bossever
Copy link
Contributor

bossever commented Feb 4, 2021 •
edited
Loading

@romani, I have created the PR but it does not come up in "Linked pull requests" on the side bar, although I have mentioned this issue with the link in the PR.
#9224

bossever added a commit to bossever/checkstyle that referenced this issue Feb 5, 2021
@bossever
Issue checkstyle#9219: Removed redundant "Unsupported cases" section …
d48919d 
…from VariableDeclarationUsageDistance check documentation
romani pushed a commit that referenced this issue Feb 7, 2021
@bossever @romani
Issue #9219: Removed redundant "Unsupported cases" section from Varia…
82f8439 
…bleDeclarationUsageDistance check documentation
@romani romani added this to the 8.41 milestone Feb 7, 2021
@romani
Copy link
Member Author

romani commented Feb 7, 2021

fix is merged

@romani romani closed this as completed Feb 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
approved miscellaneous
Projects
None yet
Milestone
8.41
Development

No branches or pull requests
2 participants
@romani @bossever