styler icon indicating copy to clipboard operation
styler copied to clipboard

Remove empty lines between roxygen comments and code

Open IndrajeetPatil opened this issue 3 years ago • 18 comments
trafficstars

@lorenzwalthert Creating a draft PR while I figure out the implementation.

As mentioned in #936, I will definitely need some help figuring out a few things since I am not sure if I follow the code logic yet. Will post more concrete questions here as I work through the implementation.

IndrajeetPatil avatar May 26 '22 08:05 IndrajeetPatil

This is how benchmark results would change (along with a 95% confidence interval in relative change) if c1673948c9db56a120945b75ae7aa5e17af3b9d0 is merged into main:

  •   :ballot_box_with_check:cache_applying: 24.5ms -> 24.1ms [-4.2%, +1.01%]
  •   :ballot_box_with_check:cache_recording: 1.08s -> 1.08s [-0.3%, +0.37%]
  •   :ballot_box_with_check:without_cache: 2.87s -> 2.85s [-2.84%, +1.35%]

Further explanation regarding interpretation and methodology can be found in the documentation.

github-actions[bot] avatar May 26 '22 09:05 github-actions[bot]

Great start @IndrajeetPatil always good to start with a skeleton and a test. I’d just put browser() in your skeleton and run the test. Then, token, token_before and token_after might be helpful. To identify roxygen comment, there might already be some Regex, eg check in the R/roxygen-* files that are used to format Code examples

lorenzwalthert avatar May 26 '22 11:05 lorenzwalthert

Ah and before we forget: at the end, we should also add a transformer drop rule.

lorenzwalthert avatar May 26 '22 11:05 lorenzwalthert

This is how benchmark results would change (along with a 95% confidence interval in relative change) if c814abb024e96d5176cb89580e6a70e42da847eb is merged into main:

  •   :ballot_box_with_check:cache_applying: 23.9ms -> 24ms [-2.49%, +2.91%]
  •   :ballot_box_with_check:cache_recording: 989ms -> 987ms [-1.44%, +1.09%]
  •   :ballot_box_with_check:without_cache: 2.64s -> 2.65s [-1.11%, +1.79%]

Further explanation regarding interpretation and methodology can be found in the documentation.

github-actions[bot] avatar May 31 '22 11:05 github-actions[bot]

This is how benchmark results would change (along with a 95% confidence interval in relative change) if 9132f22e5aa34e2c27e5491eefe513174a606fef is merged into main:

  •   :ballot_box_with_check:cache_applying: 29ms -> 29ms [-0.64%, +0.36%]
  •   :ballot_box_with_check:cache_recording: 1.25s -> 1.26s [-0.24%, +0.79%]
  •   :ballot_box_with_check:without_cache: 3.37s -> 3.36s [-0.72%, +0.11%]

Further explanation regarding interpretation and methodology can be found in the documentation.

github-actions[bot] avatar Jun 08 '22 20:06 github-actions[bot]

This is how benchmark results would change (along with a 95% confidence interval in relative change) if 81dd1f3a8bfce61a92829301533445ecebf4cd4b is merged into main:

  •   :ballot_box_with_check:cache_applying: 24.6ms -> 24.7ms [-2.07%, +2.86%]
  •   :ballot_box_with_check:cache_recording: 1.02s -> 1.02s [-1.97%, +1.2%]
  •   :ballot_box_with_check:without_cache: 2.81s -> 2.8s [-1.89%, +1.17%]

Further explanation regarding interpretation and methodology can be found in the documentation.

github-actions[bot] avatar Jun 16 '22 15:06 github-actions[bot]

This is how benchmark results would change (along with a 95% confidence interval in relative change) if e9d1a019695295edee4edb0134d6200cadfb917a is merged into main:

  •   :ballot_box_with_check:cache_applying: 22.6ms -> 22.6ms [-0.85%, +0.46%]
  •   :ballot_box_with_check:cache_recording: 963ms -> 959ms [-0.76%, 0%]
  •   :ballot_box_with_check:without_cache: 2.6s -> 2.6s [-0.72%, +0.47%]

Further explanation regarding interpretation and methodology can be found in the documentation.

github-actions[bot] avatar Jun 16 '22 17:06 github-actions[bot]

This is how benchmark results would change (along with a 95% confidence interval in relative change) if d99f9eec8ab9a77dbd870d6191abfc45e3b5c802 is merged into main:

  •   :ballot_box_with_check:cache_applying: 22.3ms -> 22.4ms [-0.35%, +0.93%]
  •   :ballot_box_with_check:cache_recording: 952ms -> 950ms [-0.78%, +0.37%]
  • :exclamation::snail:without_cache: 2.52s -> 2.54s [+0.2%, +1.17%]

Further explanation regarding interpretation and methodology can be found in the documentation.

github-actions[bot] avatar Jun 30 '22 08:06 github-actions[bot]

This is how benchmark results would change (along with a 95% confidence interval in relative change) if e1479259c9d94968bf3ec5123059e1995749be2a is merged into main:

  •   :ballot_box_with_check:cache_applying: 33.8ms -> 33.7ms [-3.15%, +2.57%]
  •   :ballot_box_with_check:cache_recording: 1.63s -> 1.63s [-1.62%, +1.33%]
  •   :ballot_box_with_check:without_cache: 4.29s -> 4.28s [-1.23%, +0.72%]

Further explanation regarding interpretation and methodology can be found in the documentation.

github-actions[bot] avatar Jul 10 '22 22:07 github-actions[bot]

This is how benchmark results would change (along with a 95% confidence interval in relative change) if b14eb36447a30ad06ed8bcebc4850bf665ef64c1 is merged into main:

  •   :ballot_box_with_check:cache_applying: 25.2ms -> 25.7ms [-0.07%, +4.02%]
  •   :ballot_box_with_check:cache_recording: 1.09s -> 1.09s [-0.98%, +0.46%]
  •   :ballot_box_with_check:without_cache: 2.94s -> 2.93s [-1.13%, +0.73%]

Further explanation regarding interpretation and methodology can be found in the documentation.

github-actions[bot] avatar Jul 13 '22 22:07 github-actions[bot]

This is how benchmark results would change (along with a 95% confidence interval in relative change) if e5714b71ebb4bcc5c25ff1f90c8bfb19e1b76811 is merged into main:

  • :exclamation::snail:cache_applying: 23.9ms -> 26.4ms [+8.26%, +12.25%]
  •   :ballot_box_with_check:cache_recording: 1.11s -> 1.12s [-0.17%, +0.8%]
  •   :ballot_box_with_check:without_cache: 2.94s -> 2.94s [-0.49%, +0.57%]

Further explanation regarding interpretation and methodology can be found in the documentation.

github-actions[bot] avatar Aug 06 '22 18:08 github-actions[bot]

This is how benchmark results would change (along with a 95% confidence interval in relative change) if 458d03674da9e8c5e71fa7b0f7e72fc8c499605a is merged into main:

  •   :ballot_box_with_check:cache_applying: 27.8ms -> 27.8ms [-0.68%, +1.31%]
  •   :ballot_box_with_check:cache_recording: 1.14s -> 1.14s [-0.51%, +0.7%]
  •   :ballot_box_with_check:without_cache: 3.04s -> 3.04s [-0.41%, +0.67%]

Further explanation regarding interpretation and methodology can be found in the documentation.

github-actions[bot] avatar Aug 15 '22 07:08 github-actions[bot]

This is how benchmark results would change (along with a 95% confidence interval in relative change) if 39fb818776930d4a3386a28234b4775eed1bc2f4 is merged into main:

  •   :ballot_box_with_check:cache_applying: 26ms -> 25.9ms [-3.32%, +2.3%]
  •   :ballot_box_with_check:cache_recording: 1.2s -> 1.21s [-1.9%, +4.18%]
  •   :ballot_box_with_check:without_cache: 3.32s -> 3.31s [-2.68%, +2.05%]

Further explanation regarding interpretation and methodology can be found in the documentation.

github-actions[bot] avatar Aug 22 '22 19:08 github-actions[bot]

This is how benchmark results would change (along with a 95% confidence interval in relative change) if 4716558bf4236db8ee61d59e8bb76adfaeb25941 is merged into main:

  •   :ballot_box_with_check:cache_applying: 34.9ms -> 34.8ms [-2.27%, +1.43%]
  •   :ballot_box_with_check:cache_recording: 1.79s -> 1.78s [-1.8%, +0.05%]
  •   :ballot_box_with_check:without_cache: 4.78s -> 4.77s [-0.88%, +0.3%]

Further explanation regarding interpretation and methodology can be found in the documentation.

github-actions[bot] avatar Aug 24 '22 09:08 github-actions[bot]

This is how benchmark results would change (along with a 95% confidence interval in relative change) if adea97fe64d37c04495ff2052055a82e1a8b9960 is merged into main:

  •   :ballot_box_with_check:cache_applying: 27.6ms -> 27.2ms [-4.14%, +1.01%]
  •   :ballot_box_with_check:cache_recording: 1.28s -> 1.28s [-0.27%, +0.72%]
  •   :ballot_box_with_check:without_cache: 3.38s -> 3.38s [-0.5%, +0.54%]

Further explanation regarding interpretation and methodology can be found in the documentation.

github-actions[bot] avatar Aug 26 '22 12:08 github-actions[bot]

This is how benchmark results would change (along with a 95% confidence interval in relative change) if 6cb2718e66416834c7dd1866adb6d370c9850e7c is merged into main:

  •   :ballot_box_with_check:cache_applying: 36.9ms -> 35.9ms [-8.06%, +2.74%]
  •   :ballot_box_with_check:cache_recording: 1.67s -> 1.66s [-2.68%, +0.9%]
  •   :ballot_box_with_check:without_cache: 4.39s -> 4.4s [-1.42%, +2.18%]

Further explanation regarding interpretation and methodology can be found in the documentation.

github-actions[bot] avatar Sep 11 '22 10:09 github-actions[bot]

This is how benchmark results would change (along with a 95% confidence interval in relative change) if cee1f3e2b11cd8af0548faed9eb59e86c6ca3493 is merged into main:

  •   :ballot_box_with_check:cache_applying: 38.4ms -> 39.7ms [-1.25%, +7.54%]
  •   :ballot_box_with_check:cache_recording: 2.02s -> 2.03s [-0.43%, +1.11%]
  •   :ballot_box_with_check:without_cache: 5.3s -> 5.31s [-0.66%, +0.93%]

Further explanation regarding interpretation and methodology can be found in the documentation.

github-actions[bot] avatar Sep 13 '22 20:09 github-actions[bot]

This is how benchmark results would change (along with a 95% confidence interval in relative change) if f48eddf1e0baaf8d05a70620abf708f657dba65f is merged into main:

  •   :ballot_box_with_check:cache_applying: 27.7ms -> 27.7ms [-0.75%, +0.67%]
  •   :ballot_box_with_check:cache_recording: 1.31s -> 1.32s [-0.41%, +0.67%]
  • :exclamation::snail:without_cache: 3.42s -> 3.44s [+0.01%, +1.07%]

Further explanation regarding interpretation and methodology can be found in the documentation.

github-actions[bot] avatar Sep 21 '22 10:09 github-actions[bot]

Codecov Report

Merging #948 (10f63a6) into main (4c1cb51) will increase coverage by 0.00%. The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #948   +/-   ##
=======================================
  Coverage   91.06%   91.07%           
=======================================
  Files          46       46           
  Lines        2687     2689    +2     
=======================================
+ Hits         2447     2449    +2     
  Misses        240      240           
Impacted Files Coverage Δ
R/rules-line-breaks.R 100.00% <100.00%> (ø)
R/style-guides.R 99.43% <100.00%> (+<0.01%) :arrow_up:

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

codecov-commenter avatar Oct 29 '22 08:10 codecov-commenter

This is how benchmark results would change (along with a 95% confidence interval in relative change) if ebea03ee72796d8a94597ad45977906b0013228a is merged into main:

  •   :ballot_box_with_check:cache_applying: 34.7ms -> 34.2ms [-5.5%, +2.95%]
  •   :ballot_box_with_check:cache_recording: 1.07s -> 1.07s [-3.1%, +1.4%]
  •   :ballot_box_with_check:without_cache: 2.71s -> 2.69s [-2.47%, +1.36%]

Further explanation regarding interpretation and methodology can be found in the documentation.

github-actions[bot] avatar Oct 29 '22 09:10 github-actions[bot]

@IndrajeetPatil do you merge manually? I keep getting notifications and I think I don’t want them I until this is ready for review. Converting to draft now.

lorenzwalthert avatar Oct 29 '22 11:10 lorenzwalthert

I had opened it as a draft. I am not sure why, but you marked it as ready for review 😅

Screenshot 2022-10-29 at 13 34 35

IndrajeetPatil avatar Oct 29 '22 11:10 IndrajeetPatil

I will actually just close this for now, since there is no value in this PR before including any functionality.

IndrajeetPatil avatar Oct 29 '22 11:10 IndrajeetPatil