Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use core 2.27.0 #785

Merged
merged 4 commits into from
Dec 12, 2024
Merged

Use core 2.27.0 #785

merged 4 commits into from
Dec 12, 2024

Conversation

johnkerl
Copy link
Collaborator

Copy link
Member

@mojaveazure mojaveazure left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please re-generate the docs by running Rscript -e "devtools::document()" from within the root of TileDB-R to restore the correct documentation for S4 subsetting methods (sub-tiledb_array, sub-tiledb_config and sub-tiledb_filter_list); running from within RStudio or using roxygen2::roxygenize() yields incorrect S4 method signatures in the docs

@johnkerl
Copy link
Collaborator Author

Please re-generate the docs by running Rscript -e "devtools::document()" from within the root of TileDB-R

@mojaveazure I did :|

If I did that wrongly I need to know how to do it rightly ...

@johnkerl
Copy link
Collaborator Author

If I did that wrongly I need to know how to do it rightly ...

Ah, I had done devtools::document() at the R prompt but had forgotten to isntead invoke it as

Rscript -e 'devtools::document()

-- my apologies!

@johnkerl
Copy link
Collaborator Author

@mojaveazure commit 4: 82db624

@johnkerl johnkerl requested a review from mojaveazure December 12, 2024 01:23
@mojaveazure
Copy link
Member

When I run devtools::document() from Rscript, I see the corresponding Rd files change

paul@tiledb-ph:~/software/TileDB-R$ git branch
* kerl/core-2.27.0
  main
paul@tiledb-ph:~/software/TileDB-R$ git log -1 --oneline
6b76b505 (HEAD -> kerl/core-2.27.0, origin/kerl/core-2.27.0) Run devtools::document()
paul@tiledb-ph:~/software/TileDB-R$ lsb_release -a
No LSB modules are available.
Distributor ID: Ubuntu
Description:    Ubuntu 24.04.1 LTS
Release:        24.04
Codename:       noble
paul@tiledb-ph:~/software/TileDB-R$ Rscript -e 'getRversion()' -e 'packageVersion("devtools")' -e "devtools::document()"
[1] ‘4.4.2’
[1] ‘2.4.5’
ℹ Updating tiledb documentation
ℹ Loading tiledb
Writing sub-tiledb_config-ANY-method.Rd
Writing sub-tiledb_filter_list-ANY-method.Rd
Writing sub-tiledb_array-ANY-method.Rd
paul@tiledb-ph:~/software/TileDB-R$ git diff man/sub-tiledb_array-ANY-method.Rd
diff --git a/man/sub-tiledb_array-ANY-method.Rd b/man/sub-tiledb_array-ANY-method.Rd
index e623a169..3b5c6266 100644
--- a/man/sub-tiledb_array-ANY-method.Rd
+++ b/man/sub-tiledb_array-ANY-method.Rd
@@ -1,14 +1,14 @@
 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/TileDBArray.R
-\name{[,tiledb_array,ANY,ANY,ANY-method}
-\alias{[,tiledb_array,ANY,ANY,ANY-method}
+\name{[,tiledb_array,ANY-method}
+\alias{[,tiledb_array,ANY-method}
 \alias{[,tiledb_array}
 \alias{[,tiledb_array-method}
 \alias{[,tiledb_array,ANY,tiledb_array-method}
 \alias{[,tiledb_array,ANY,ANY,tiledb_array-method}
 \title{Returns a TileDB array, allowing for specific subset ranges.}
 \usage{
-\S4method{[}{tiledb_array,ANY,ANY,ANY}(x, i, j, ..., drop = FALSE)
+\S4method{[}{tiledb_array,ANY}(x, i, j, ..., drop = FALSE)
 }
 \arguments{
 \item{x}{tiledb_array object}

@mojaveazure
Copy link
Member

Oop, just saw your other comments. Yeah, must be done from Rscript invoked from the shell (Rscript.exe on Windows), not the R prompt. I've made sure this is noted in the Notion, but if the wording is unclear please let me know so we can clarify it

Copy link
Member

@mojaveazure mojaveazure left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM assuming CI runs succesfully; thanks for taking care of this!

@johnkerl johnkerl merged commit 39fbcc1 into main Dec 12, 2024
12 checks passed
@johnkerl johnkerl deleted the kerl/core-2.27.0 branch December 12, 2024 01:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants