docs: note that ansi_substr/ansi_substring do not support replacement form#828
Closed
LeonidasZhak wants to merge 2 commits into
Closed
docs: note that ansi_substr/ansi_substring do not support replacement form#828LeonidasZhak wants to merge 2 commits into
LeonidasZhak wants to merge 2 commits into
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.
… form The documentation for ansi_substr() and ansi_substring() stated they work 'exactly like' their base R counterparts, but unlike base::substr() and base::substring(), the replacement forms (e.g., ansi_substr(x, 1, 3) <- value) are not implemented. Update the descriptions to clarify this difference. Closes #774.
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.
Fixes #774.
Summary
The documentation for
ansi_substr()andansi_substring()stated they work "exactly like" their base R counterparts (base::substr()andbase::substring()). However, unlike the base functions, the replacement forms (ansi_substr(x, start, stop) <- valueandsubstring(text, first, last) <- value) are not implemented.This PR updates the descriptions to clarify this difference by:
Changes
R/ansiex.R: Updated roxygen comments for bothansi_substr()andansi_substring()man/ansi_substr.Rd: Regenerated Rd fileman/ansi_substring.Rd: Regenerated Rd fileChecks
tools::checkRd("man/ansi_substr.Rd")— cleantools::checkRd("man/ansi_substring.Rd")— cleanR CMD build --no-build-vignettes .— cleanR CMD check --no-manual --no-tests --no-vignettes --no-examples— Status: OK