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

revise: makes various improvements to the line_width rule #130

Merged
merged 1 commit into from
Jul 19, 2024

Conversation

claymcleod
Copy link
Member

@claymcleod claymcleod commented Jul 16, 2024

In attempting to fix the line_width rule, I discovered that the problem was actually in the way we did excepting of rules. That's probably a PR for a different day, but I made some improvements to the rule in terms of conciseness that I'd like to go ahead and merge in.

@claymcleod claymcleod force-pushed the fix/line_width branch 3 times, most recently from 26a6448 to 62b60dd Compare July 18, 2024 21:26
Arena.toml Show resolved Hide resolved
message = "arriba.wdl:140:1: note[LineWidth]: line exceeds maximum width of 90"
permalink = "https://github.com/stjudecloud/workflows/blob/833b97fb582fe7d4f6df9d29a645d0289f1fc92e/tools/arriba.wdl/#L140"
message = "read_group.wdl:134:1: note[LineWidth]: line exceeds maximum width of 90"
permalink = "https://github.com/stjudecloud/workflows/blob/129060215443bbd1b67c4d3d149d48acdab90ef2/data_structures/read_group.wdl/#L134"
Copy link
Member Author

Choose a reason for hiding this comment

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

This is still going to exist until we implement the fix we discussed in Slack. That is probably the another PR in the future.

message = "deeptools.wdl:6:7: note[Todo]: remaining `TODO` item found"
permalink = "https://github.com/stjudecloud/workflows/blob/833b97fb582fe7d4f6df9d29a645d0289f1fc92e/tools/deeptools.wdl/#L6"
message = "arriba.wdl:147:1: note[LineWidth]: line exceeds maximum width of 90"
permalink = "https://github.com/stjudecloud/workflows/blob/129060215443bbd1b67c4d3d149d48acdab90ef2/tools/arriba.wdl/#L147"
Copy link
Member Author

Choose a reason for hiding this comment

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

Same here.

@@ -89,8 +83,7 @@ impl Rule for LineWidthRule {
}

fn description(&self) -> &'static str {
"Ensures that lines do not exceed a certain width. That width is currently set to 90 \
characters."
"Ensures that lines do not exceed a certain width."
Copy link
Member Author

Choose a reason for hiding this comment

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

The default should be described in the explanation (which it is), so it can be removed here.

@claymcleod claymcleod force-pushed the fix/line_width branch 2 times, most recently from 3586337 to 3169e52 Compare July 18, 2024 21:34
@claymcleod claymcleod changed the title fix: fixes the line_width rule revise: makes various improvements to the line_width rule Jul 18, 2024
@claymcleod
Copy link
Member Author

Explicitly, I don't think this needs a CHANGELOG.md entry, as just the internals of the rule changed (and not it's behavior or interface).

note[LineWidth]: line exceeds maximum width of 90
┌─ tests/lints/line-width/source.wdl:31:1
31 │ ╭ command <<<
Copy link
Member Author

Choose a reason for hiding this comment

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

See the comment in the source text for this diagnostic.

@claymcleod claymcleod requested review from a-frantz, peterhuene and adthrasher and removed request for a-frantz July 18, 2024 21:43
@claymcleod claymcleod self-assigned this Jul 18, 2024
@claymcleod claymcleod marked this pull request as ready for review July 18, 2024 21:43
@claymcleod claymcleod merged commit f587679 into main Jul 19, 2024
7 checks passed
@claymcleod claymcleod deleted the fix/line_width branch July 19, 2024 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants