UMM-CSci-3601 / intro-to-git

A group exercise practicing with various git ideas and tools
MIT License
2 stars 7 forks source link

Fix inconsistency in how spacing is handled by Checkstyle #101

Closed NicMcPhee closed 8 months ago

NicMcPhee commented 2 years ago

@jpwalbran pointed out on Slack that Checkstyle isn't being super consistent about spacing around braces:

I noticed a thing about the checkstyle. As part of some of the tests for lab 2, we’d have a line like

queryParams.put("orderBy", Arrays.asList(new String[] {"body"}));

This passes checkstyle fine. However,

queryParams.put("orderBy", Arrays.asList(new String[] { "body" }));

This does not, because of the space between { and "body". The thing that I noticed was that

queryParams.put("orderBy", Arrays.asList(new String[] {"body" }));

also passes checkstyle, and I feel that it shouldn’t.

It's not our job to "fix Checkstyle", but it is weird that there is this inconsistency. I'm not 100% sure I "like" the brace/space rule anyway, so maybe we just remove that rule?

This would apply to almost all the subsequent labs, and the iteration template.

NicMcPhee commented 8 months ago

I'm guessing that this documentation page has the info we need to fix this issue.

After spending way too long, I've confirmed that this is still an issue. I'm less clear on whether it's an issue that we actually care much about.

I'm not going to wrestle with it at the moment, but I'd be happy to have someone else look into it.