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

Remove empty lines between roxygen comments and code #948

Closed
wants to merge 20 commits into from
Closed

Remove empty lines between roxygen comments and code #948

wants to merge 20 commits into from

Conversation

IndrajeetPatil
Copy link
Collaborator

@IndrajeetPatil IndrajeetPatil commented May 26, 2022

@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.

@github-actions

This comment was marked as outdated.

@lorenzwalthert
Copy link
Collaborator

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
Copy link
Collaborator

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

@github-actions

This comment was marked as outdated.

@lorenzwalthert lorenzwalthert marked this pull request as ready for review May 31, 2022 12:03
@github-actions

This comment was marked as duplicate.

@github-actions

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@github-actions
Copy link
Contributor

This is how benchmark results would change (along with a 95% confidence interval in relative change) if cee1f3e 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
Copy link
Contributor

This is how benchmark results would change (along with a 95% confidence interval in relative change) if f48eddf 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%]
  • ❗🐌without_cache: 3.42s -> 3.44s [+0.01%, +1.07%]

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

@codecov-commenter
Copy link

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%) ⬆️

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

@github-actions
Copy link
Contributor

This is how benchmark results would change (along with a 95% confidence interval in relative change) if ebea03e 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.

@lorenzwalthert
Copy link
Collaborator

@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 lorenzwalthert marked this pull request as draft October 29, 2022 11:11
@IndrajeetPatil
Copy link
Collaborator Author

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
Copy link
Collaborator Author

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

@IndrajeetPatil IndrajeetPatil deleted the 936_empty_line_before_roxygen branch October 29, 2022 11:45
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.

3 participants