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

How to document S7 classes/generics? #302

Closed
Sage0614 opened this issue May 23, 2023 · 1 comment · Fixed by #312
Closed

How to document S7 classes/generics? #302

Sage0614 opened this issue May 23, 2023 · 1 comment · Fixed by #312

Comments

@Sage0614
Copy link

I am using S7 class in my own package, currently seems there's no material I can find about how to properly document properties with a S7 class in roxygen2 style, and I got a lot of warnings of undocumented arguments when I run devtools::check(), It would be helpful to have a vignette that how S7 class and instance from S7 class should be documented when building packages upon them, so we have some approach we agreed on.

@hadley
Copy link
Member

hadley commented May 23, 2023

I've filed an issue to add S7 support to roxygen2: r-lib/roxygen2#1484

But I'll keep this issue open because it'll be good to discuss how we expect the .Rd files for S7 classes, generics, and methods to look.

@hadley hadley changed the title add a vignette for how to document S7 class with roxygen2 style How to document S7 with roxygen2? Jun 27, 2023
@hadley hadley changed the title How to document S7 with roxygen2? How to document S7 classes/generics? Jun 27, 2023
hadley added a commit that referenced this issue Jul 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants