Repository navigation
Set off each comment with one blank line? #1076
Description
Preamble
An effective way to get an overview of the code is to read the comments without reading the code. Setting comments off with a blank line helps distinguish code from comments and makes it easy for the reader to scan the code or the comment.
Actual
This is a minimal reprex to illustrate the issue, but you can scale this to more complex comments and highly involved code block below each comment.
styler::style_text("# comment-1
if (TRUE) {
# comment-2
x <- 1
# comment-3
a <- 3
}
# comment-4
x + 1")
#> # comment-1
#> if (TRUE) {
#> # comment-2
#> x <- 1
#> # comment-3
#> a <- 3
#> }
#> # comment-4
#> x + 1Created on 2022-11-30 with reprex v2.0.2
Expected
Note that this doesn't apply to the comments at the start of the scope.
#> # comment-1
#> if (TRUE) {
#> # comment-2
#> x <- 1
+ #>
#> # comment-3
#> a <- 3
#> }
+ #>
#> # comment-4
#> x + 1
Activity
lorenzwalthert commentedon Nov 30, 2022
I see the use case, but most people won't want this always. Note that {styler} preserves line breaks around comments in certain situations (search the issues for more context), e.g. in your case,
Created on 2022-11-30 with reprex v2.0.2
Hence, I consider such an invasive formatting out of scope for {styler}. Maybe also check out https://github.com/lionel-/codegrip?
IndrajeetPatil commentedon Nov 30, 2022
Maybe this can be an optional argument? E.g.
offset_comment_with_one_blank_line?styler/R/style-guides.R
Line 68 in d137eb6
I didn't get the connection between this comment and the reprex in your comment.
Looking at the roadmap section of codegrip, I doubt it's in the scope of that package either.
lorenzwalthert commentedon Nov 30, 2022
Fixed, I meant comments, not commas :D
lorenzwalthert commentedon Dec 27, 2022
I am not gonna implement this, but if you want, you can send a PR. I think the default should be the current behavior.