Skip to content

Don't error no empty roxygen example#1096

Merged
lorenzwalthert merged 2 commits intomainfrom
issue-1095
Feb 14, 2023
Merged

Don't error no empty roxygen example#1096
lorenzwalthert merged 2 commits intomainfrom
issue-1095

Conversation

@lorenzwalthert
Copy link
Collaborator

Closes #1095.

@codecov-commenter
Copy link

Codecov Report

Merging #1096 (f5d9b62) into main (5d3390e) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #1096   +/-   ##
=======================================
  Coverage   91.07%   91.07%           
=======================================
  Files          46       46           
  Lines        2711     2712    +1     
=======================================
+ Hits         2469     2470    +1     
  Misses        242      242           
Impacted Files Coverage Δ
R/ui-styling.R 100.00% <ø> (ø)
R/rules-line-breaks.R 100.00% <100.00%> (ø)
R/transform-files.R 97.48% <100.00%> (ø)

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 e6fadbf is merged into main:

  •   :ballot_box_with_check:cache_applying: 48.5ms -> 48.3ms [-1.09%, +0.43%]
  •   :ballot_box_with_check:cache_recording: 770ms -> 768ms [-0.59%, +0.25%]
  •   :ballot_box_with_check:without_cache: 1.84s -> 1.84s [-0.81%, +0.16%]

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 e6fadbf is merged into main:

  •   :ballot_box_with_check:cache_applying: 53.1ms -> 53.2ms [-0.73%, +1.14%]
  •   :ballot_box_with_check:cache_recording: 855ms -> 853ms [-0.78%, +0.32%]
  •   :ballot_box_with_check:without_cache: 2.05s -> 2.05s [-0.62%, +0.3%]

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

@lorenzwalthert
Copy link
Collaborator Author

@IndrajeetPatil I also updated NEWS.md in main and we have at least two critical fixes in addition to this one so I think we're cut for a patch release.

Copy link
Collaborator

@IndrajeetPatil IndrajeetPatil left a comment

Choose a reason for hiding this comment

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

Thanks, @lorenzwalthert!

Also, tested the following two cases for a good measure, and everything looks good.
Thanks for finding the fix so quickly.

library(styler)

"#' Empty line in examples
#'
#' @examplesIf TRUE
#' \\donttest{
#' }
3" -> code

style_text(code)
#> #' Empty line in examples
#> #'
#> #' @examplesIf TRUE
#> #' \donttest{
#> #'
#> #' }
#> 3

"#' Empty line in examples
#'
#' @examples
#' \\dontshow{
#' }
4" -> code

style_text(code)
#> #' Empty line in examples
#> #'
#> #' @examples
#> #' \dontshow{
#> #'
#> #' }
#> 4

Created on 2023-02-14 with reprex v2.0.2

@lorenzwalthert lorenzwalthert merged commit ac65cb6 into main Feb 14, 2023
@lorenzwalthert lorenzwalthert deleted the issue-1095 branch February 14, 2023 09:10
@IndrajeetPatil
Copy link
Collaborator

@IndrajeetPatil I also updated NEWS.md in main and we have at least two critical fixes in addition to this one so I think we're cut for a patch release.

I concur!

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.

Empty line in @examples causes uninformative error

3 participants