-
Notifications
You must be signed in to change notification settings - Fork 636
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
describe @exportS3Method for non-owned generics and delayed method registration #1087
Merged
Conversation
This file contains 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
hadley
reviewed
Aug 15, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice improvement! I've added a few comments/questions.
tanho63
commented
Aug 15, 2024
tanho63
commented
Aug 15, 2024
Co-authored-by: Hadley Wickham <hadley@posit.co>
tanho63
commented
Aug 15, 2024
hadley
reviewed
Aug 15, 2024
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #1032 and closes #1082.
Cleans up the section about exporting S3 methods for non-owned generics to recommend using
exportS3Method
in all scenarios (hard and soft dependencies).For generics owned by hard dependencies (ie
Depends
andImports
), this previously described a workflow that required importing the generic into the NAMESPACE so that the method could be exported via@export
- it seems like this can be skipped and we can use@exportS3Method
directly in this scenario.For generics owned by soft dependencies (ie
Suggests
), this described a methodology around registering S3 methodsonLoad()
, and suggested ans3_register()
function that needed to be included in the package body. This is no longer required as of R 3.6, which now interprets theS3method()
directive in NAMESPACE to automatically register the method on dependency load. This means we can use@exportS3Method
for this scenario as well, and remove the section on conditional/delayed load entirely.I'm unsure if it would be worth mentioning how to handle things for pre R3.6 (and hide the deleted section in a collapsed details block?) - R 3.6 is quite old now.