MINOR: [R] cast() documented but not exported in NAMESPACE#49854
Open
AnkitAhlawat7742 wants to merge 1 commit intoapache:mainfrom
Open
MINOR: [R] cast() documented but not exported in NAMESPACE#49854AnkitAhlawat7742 wants to merge 1 commit intoapache:mainfrom
cast() documented but not exported in NAMESPACE#49854AnkitAhlawat7742 wants to merge 1 commit intoapache:mainfrom
Conversation
|
Thanks for opening a pull request! If this is not a minor PR. Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose Opening GitHub issues ahead of time contributes to the Openness of the Apache Arrow project. Then could you also rename the pull request title in the following format? or See also: |
cast() documented but not exported in NAMESPACE
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
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.
FIX #49852
Rationale for this change
cast() is a publicly documented function available at https://arrow.apache.org/docs/r/reference/cast.html and is intended for use in dplyr pipelines. However, it was marked with @Keywords internal which prevented it from being exported in the NAMESPACE file.
What changes are included in this PR?
Removed @Keywords internal tag which was incorrectly marking cast() as an internal function
Added @export tag so that devtools::document() adds cast to the NAMESPACE file, making it publicly accessible to users
Are these changes tested?
Existing tests in the test suite already cover cast(). No new tests needed as only the export tag was changed, not the implementation.
Are there any user-facing changes?
Yes. cast() can now be called directly by users as documented: