Update documentation for nanoarrow refactor, deprecate helpers
#685
Conversation
This file contains 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
|
This pull request has been linked to Shortcut Story #44257: Update documentation and helper functions following |
|
Better to properly deprecate the four redundant function and replace them with > library(tiledb)
TileDB R 0.25.0.6 with TileDB Embedded 2.22.0 on Ubuntu 23.10.
See https://tiledb.com for more information about TileDB.
> aa <- tiledb_arrow_array_ptr()
Warning message:
tiledb_arrow_array_ptr() is deprecated, please use nanoarrow::nanoarrow_allocate_array() instead.
> |
eddelbuettel
changed the title
nanoarrow refactor, remove helpersnanoarrow refactor, deprecate helpers
ihnorton
approved these changes
Apr 1, 2024
Merged
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.
In #682 (yesterday, building on #663 last month) use of
nanoarrowwas expanded in a refactoring. This a) removed the need for four helper functions and b) lead to one variable renaming for which roxygen docs needed to be updated. This PR addresses both points.Removing user-callable functions is an API change.
These four were arguably internal but if the feeling is we should preserve them with deprecation I can add four empty shells. On balance, and in this use case, this seems overkill but then again API consistency is important.The functions remain, but are marked deprecated. They are not used by any package code, but can remain until a suitable deprecation time has passed.