docs: add missing @return tags to exported functions - #846
Closed
LeonidasZhak wants to merge 1 commit into
Closed
Conversation
Add @return documentation tags to exported functions whose generated Rd files lacked \value sections. R CMD check --as-cran notes missing \value for exported functions; this is also a CRAN submission requirement. Functions documented: - ctl_new_pillar_list(): list of pillar objects - new_pillar_component()/pillar_component(): pillar_component object - new_pillar_shaft(): pillar shaft object - pillar_shaft(): pillar shaft object - new_pillar_title(): pillar_title object - new_pillar_type(): pillar_type object - format_type_sum(): styled character string - scale_x_num()/scale_y_num(): ggplot2 scale object Also regenerated all Rd files to include pre-existing @return tags that were present in the R source but not reflected in man pages.
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.
Add
@returndocumentation tags to exported functions whose generated Rd files lacked\valuesections. R CMD check --as-cran notes missing\valuefor exported functions; this is also a CRAN submission requirement.Functions documented
ctl_new_pillar_list()new_pillar_component()/pillar_component()pillar_componentobjectnew_pillar_shaft()c(class, "pillar_shaft")pillar_shaft()new_pillar_title()pillar_titleobjectnew_pillar_type()pillar_typeobjectformat_type_sum()scale_x_num()/scale_y_num()Validation
R CMD build --no-build-vignettes: succeedsR CMD check --no-manual --no-vignettes --no-tests: 2 WARNINGs (pre-existing vignette issues, unrelated)Diff
36 files changed, 109 insertions, 2 deletions