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

Add examples to documentation: Part-8 (t-z) #1686

Merged
merged 14 commits into from
Oct 12, 2022
Merged

Conversation

IndrajeetPatil
Copy link
Collaborator

Part of #1492

Doesn't close the issue yet. A couple of items and some cleanup remaining.

R/comment_linters.R Outdated Show resolved Hide resolved
#'
#' # okay
#' lint(
#' text = "x <- NULL",
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would also present the alternative of x <- integer(10) for cases where c() was meant to seed a vector of known size

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think it warrants a comment on the example to say why it's there, otherwise there's a bit of a "what's this example got to do w anything?" reaction

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good point. Added a comment.

@codecov-commenter
Copy link

codecov-commenter commented Oct 12, 2022

Codecov Report

Merging #1686 (2ba4a1d) into main (54a0c18) will decrease coverage by 0.00%.
The diff coverage is 100.00%.

❗ Current head 2ba4a1d differs from pull request most recent head 32f70c5. Consider uploading reports for the commit 32f70c5 to get more accurate results

@@            Coverage Diff             @@
##             main    #1686      +/-   ##
==========================================
- Coverage   98.71%   98.71%   -0.01%     
==========================================
  Files         104      104              
  Lines        4499     4497       -2     
==========================================
- Hits         4441     4439       -2     
  Misses         58       58              
Impacted Files Coverage Δ
R/comment_linters.R 100.00% <ø> (ø)
R/trailing_blank_lines_linter.R 100.00% <ø> (ø)
R/undesirable_function_linter.R 100.00% <ø> (ø)
R/undesirable_operator_linter.R 100.00% <ø> (ø)
R/unneeded_concatenation_linter.R 100.00% <ø> (ø)
R/unreachable_code_linter.R 100.00% <ø> (ø)
R/unused_import_linter.R 100.00% <ø> (ø)
R/vector_logic_linter.R 100.00% <ø> (ø)
R/yoda_test_linter.R 100.00% <ø> (ø)
R/trailing_whitespace_linter.R 100.00% <100.00%> (ø)

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

Copy link
Collaborator

@MichaelChirico MichaelChirico left a comment

Choose a reason for hiding this comment

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

Almost done!

@IndrajeetPatil IndrajeetPatil merged commit 2160d87 into main Oct 12, 2022
@IndrajeetPatil IndrajeetPatil deleted the 1492_examples_ty branch October 12, 2022 11:09
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