docs: add missing @return tags to exported functions#827
Closed
LeonidasZhak wants to merge 1 commit into
Closed
Conversation
Add @return roxygen tags and corresponding \value Rd sections for: - spark_bar(), spark_line() (R/spark.R) - ruler() (R/ruler.R) - simple_theme() (R/simple-theme.R) - format_error(), format_warning(), format_message() (R/format-conditions.R) - test_that_cli() (R/test.R) Also fix typo in R/bullets.R: cli_format_bullets_raw() -> cli_bullets_raw() R CMD check --as-cran requires \value for all exported functions.
Contributor
Author
|
Withdrawing this small automated PR while I consolidate an oversized batch of contributions and reduce maintainer review burden. Sorry for the noise, and thank you for maintaining the project. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
@returnroxygen tags and corresponding\valueRd sections to 6 exported function families in cli whose generated.Rdfiles lacked\valuesections. R CMD check --as-cran notes missing\valuefor exported functions; this is also a CRAN submission requirement.Changes
R source files (add
@returnroxygen tags)@returnR/spark.Rspark_bar(),spark_line()cli_spark_bar/cli_spark_lineR/ruler.Rruler()NULL, invisiblyR/simple-theme.Rsimple_theme()R/format-conditions.Rformat_error(),format_warning(),format_message()R/test.Rtest_that_cli()testthat::test_that()Rd files (manually added
\valuesections)man/spark_bar.Rd,man/spark_line.Rd,man/ruler.Rd,man/simple_theme.Rd,man/format_error.Rd,man/test_that_cli.RdBonus fix
R/bullets.R: Fix typo in roxygen comment —cli_format_bullets_raw()→cli_bullets_raw()(the actual function name)Validation
tools::checkRd()on all 6 modified Rd files: clean (spark_line.Rd has a pre-existing title-period warning, unrelated)R CMD build --no-build-vignettes: succeedsR CMD check --no-manual --no-vignettes: Status OKDuplicate check
@returntags or\valuedocumentation