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

Documents for S3 methods (of operators) #551

Open
eitsupi opened this issue Nov 28, 2023 · 0 comments
Open

Documents for S3 methods (of operators) #551

eitsupi opened this issue Nov 28, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@eitsupi
Copy link
Collaborator

eitsupi commented Nov 28, 2023

Currently, the S3 methods of the base R functions are listed in a separate category in the documentation, but as for the operators, they belong to the functions to which they are translated.

r-polars/R/expr__expr.R

Lines 170 to 179 in 2fbf67d

#' @export
#' @rdname Expr_add
#' @param e1 Expr only
#' @param e2 Expr or anything that can be converted to a literal
"+.Expr" = function(e1, e2) {
if (missing(e2)) {
return(e1)
}
result(wrap_e(e1)$add(e2)) |> unwrap("using the '+'-operator")
}

I think it would be more convenient to be able to easily check which functions are supported by S3, so I think it would be better to move these to the S3 category.

@eitsupi eitsupi added the documentation Improvements or additions to documentation label Nov 28, 2023
@eitsupi eitsupi added the good first issue Good for newcomers label Jan 26, 2024
@eitsupi eitsupi self-assigned this Mar 3, 2024
@eitsupi eitsupi removed the good first issue Good for newcomers label Mar 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant