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

Docs: remove roxygen warnings, register non-exported S3 methods #607

Merged
merged 1 commit into from
Sep 14, 2024

Conversation

markheckmann
Copy link
Contributor

Change: registered non-exported S3 methods.

Roxygen complaints because of non-exported S3 methods.

ℹ Updating officer documentation
ℹ Loading officer
✖ core_properties.R:54: S3 method `[<-.core_properties` needs @export or
  @exportS3method tag.
✖ custom_properties.R:53: S3 method `[.custom_properties` needs @export or
  @exportS3method tag.
... 

These have to be exported as documented here:

You must register, i.e. @export, every S3 method regardless of whether or not the generic is exported. roxygen2 will warn you if you have forgotten.

This does not generate new .Rd entries. See also this discussion for details.

Roxygen throws warings. Export of s3 methods required. See discussion here: r-lib/roxygen2#1592
@davidgohel davidgohel merged commit 04c9dcb into davidgohel:master Sep 14, 2024
3 checks passed
@markheckmann markheckmann deleted the update_roxygen branch September 17, 2024 13:09
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