Add examples to documentation: Part-7 (q-s)

[IndrajeetPatil]

Part of #1492

[codecov-commenter]

Codecov Report

Merging #1674 (ef84b97) into main (615f72a) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #1674   +/-   ##
=======================================
  Coverage   98.70%   98.70%           
=======================================
  Files         103      103           
  Lines        4489     4495    +6     
=======================================
+ Hits         4431     4437    +6     
  Misses         58       58           

Impacted Files	Coverage Δ
R/function_left_parentheses_linter.R	100.00% <ø> (ø)
R/redundant_equals_linter.R	100.00% <ø> (ø)
R/redundant_ifelse_linter.R	100.00% <ø> (ø)
R/regex_subset_linter.R	100.00% <ø> (ø)
R/semicolon_linter.R	100.00% <ø> (ø)
R/seq_linter.R	100.00% <ø> (ø)
R/spaces_inside_linter.R	100.00% <ø> (ø)
R/spaces_left_parentheses_linter.R	100.00% <ø> (ø)
R/sprintf_linter.R	100.00% <ø> (ø)
R/string_boundary_linter.R	100.00% <ø> (ø)
... and 3 more

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

[MichaelChirico]

can you check the coverage report?

[IndrajeetPatil]

If I am reading this correctly, the coverage drop in methods.R

is due to change here

But this change wasn't made in this PR, so it's confusing why the coverage drop is associated with this PR.

[IndrajeetPatil]

Okay, this one is surprising:

[MichaelChirico]

in an earlier linter (function_left_parentheses_linter? is that the name?) we showed if/function signature examples, should we do the reverse here?

[IndrajeetPatil]

Not sure what you mean by "reverse" here.

[MichaelChirico]

Complementary examples to these:

lintr/R/function_left_parentheses_linter.R

Lines 21 to 40 in 615f72a

	#' # okay
	#' lint(
	#' text = "mean(x)",
	#' linters = function_left_parentheses_linter()
	#' )
	#'
	#' lint(
	#' text = "stats::sd(c(x, y, z))",
	#' linters = function_left_parentheses_linter()
	#' )
	#'
	#' lint(
	#' text = "if (TRUE) x else y",
	#' linters = function_left_parentheses_linter()
	#' )
	#'
	#' lint(
	#' text = "foo <- function(x) (x + 1)",
	#' linters = function_left_parentheses_linter()
	#' )

[IndrajeetPatil]

So including the okay examples but with a space to show that this doesn't lint with spaces_left linter?

library(lintr)

lint(
  text = "mean (x)",
  linters = spaces_left_parentheses_linter()
)

lint(
  text =  "stats::sd (c (x, y, z))",
  linters = spaces_left_parentheses_linter()
)

lint(
  text =  "if (TRUE) x else y",
  linters = spaces_left_parentheses_linter()
)

lint(
  text =  "foo <- function (x) (x + 1)",
  linters = spaces_left_parentheses_linter()
)

^{Created on 2022-10-11 with reprex v2.0.2}

[MichaelChirico]

Hmm, now I'm doubting everything :)

I definitely don't think examples like mean (x) are helpful... but maybe the better thing to do is just remove the if() example from function_left_parentheses_linter()? Since if() is irrelevant to that linter, and is covered here instead.

And then add cross-links between these two linters' help pages since they're so closely related.

WDYT?

[IndrajeetPatil]

SGTM. I have made the necessary changes. See if this is better.