Open
Conversation
JosiahParry
requested changes
Mar 16, 2026
Comment on lines
+27
to
+28
| - Every exported function in rextendr must include the following roxygen | ||
| variables: |
Contributor
There was a problem hiding this comment.
Suggested change
| - Every exported function in rextendr must include the following roxygen | |
| variables: | |
| roclets: |
| - the default value, if one exists | ||
| - `@return` — what the function returns, including the R type. | ||
| - The `@details` and `@examples` sections are optional, but should in general be | ||
| included. |
Contributor
There was a problem hiding this comment.
examples are required by CRAN. this is not optional
| The extendr project has three main areas where you can contribute: | ||
|
|
||
| **extendr crates** — The core Rust library. This is where the `#[extendr]` | ||
| macro, R type bindings, and the bulk of the Rust API live. |
Contributor
There was a problem hiding this comment.
Suggested change
| macro, R type bindings, and the bulk of the Rust API live. | |
| macro, R type bindings, and the Rust API live. |
Comment on lines
+17
to
+18
| **rextendr package** — The R package that scaffolds new extendr projects | ||
| and generates R wrapper functions. Contributions here require R |
Contributor
There was a problem hiding this comment.
Suggested change
| **rextendr package** — The R package that scaffolds new extendr projects | |
| and generates R wrapper functions. Contributions here require R | |
| **rextendr package** — The R package that scaffolds new extendr projects. | |
| Contributions here require R |
Contributor
There was a problem hiding this comment.
Technically devtools::document() does the wrapper generation now
Comment on lines
+149
to
+170
| ```{.rust filename="inst/templates/document.rs"} | ||
| // Generated by extendr: Do not edit by hand | ||
| fn main() -> Result<(), Box<dyn std::error::Error>> { | ||
| let wrapper_path = "../R/extendr-wrappers.R"; | ||
| let header = "\ | ||
| # Generated by extendr: Do not edit by hand\n\ | ||
| # nolint start\n\ | ||
| \n\ | ||
| #' @usage NULL\n\ | ||
| #' @useDynLib {{{pkg_name}}}, .registration = TRUE\n\ | ||
| NULL\n\ | ||
| \n\ | ||
| "; | ||
| let footer = "# nolint end\n"; | ||
| let wrappers = {{{lib_name}}}::get_{{{mod_name}}}_metadata() | ||
| .make_r_wrappers(true, "{{{pkg_name}}}") | ||
| .map_err(|e| format!("failed to generate wrappers: {e}"))?; | ||
| std::fs::write(wrapper_path, format!("{header}{wrappers}{footer}")) | ||
| .map_err(|e| format!("failed to write {wrapper_path}: {e}"))?; | ||
| Ok(()) | ||
| } | ||
| ``` |
Contributor
There was a problem hiding this comment.
Suggested change
| ```{.rust filename="inst/templates/document.rs"} | |
| // Generated by extendr: Do not edit by hand | |
| fn main() -> Result<(), Box<dyn std::error::Error>> { | |
| let wrapper_path = "../R/extendr-wrappers.R"; | |
| let header = "\ | |
| # Generated by extendr: Do not edit by hand\n\ | |
| # nolint start\n\ | |
| \n\ | |
| #' @usage NULL\n\ | |
| #' @useDynLib {{{pkg_name}}}, .registration = TRUE\n\ | |
| NULL\n\ | |
| \n\ | |
| "; | |
| let footer = "# nolint end\n"; | |
| let wrappers = {{{lib_name}}}::get_{{{mod_name}}}_metadata() | |
| .make_r_wrappers(true, "{{{pkg_name}}}") | |
| .map_err(|e| format!("failed to generate wrappers: {e}"))?; | |
| std::fs::write(wrapper_path, format!("{header}{wrappers}{footer}")) | |
| .map_err(|e| format!("failed to write {wrapper_path}: {e}"))?; | |
| Ok(()) | |
| } | |
| ``` |
this isn't necessary and may change.
Comment on lines
+198
to
+199
| Shell scripts run by R when the package is uninstalled. They remove the | ||
| generated `src/Makevars` and `src/Makevars.win` files respectively. No newline at end of file |
Contributor
There was a problem hiding this comment.
This is not correct. These are run at the end of package installation
Comment on lines
+1
to
+5
| version: | ||
| r: "4.2" | ||
| rust: "1.65.0" | ||
| extendr: "0.8.1" | ||
| rextendr: "0.4.2.9000" |
Contributor
There was a problem hiding this comment.
I'm anti yaml.
Think we can change this to?
[versions]
r = "4.5"
rust = "1.71"
rextendr = "0.4"Can read it with tomledit::read_toml(".variables.toml")
| ## Codebase | ||
|
|
||
| **extendr** | ||
| version: 0.8.1 |
Contributor
There was a problem hiding this comment.
Version is gonna trip claude up. This is the type of false flag that claude LOVES to get hung up on!
Suggested change
| version: 0.8.1 |
| need to understand extendr's API, types, macros, or implementation details. | ||
|
|
||
| **rextendr** | ||
| version: 0.4.2.9000 (dev) |
Contributor
There was a problem hiding this comment.
Suggested change
| version: 0.4.2.9000 (dev) |
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
2 participants
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.
Addresses #76
Changes:
cargo run --quiet)