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

Should roxygen warn when S3 methods are not tagged with @export? #1175

Closed
lionel- opened this issue Nov 26, 2020 · 1 comment · Fixed by #1534
Closed

Should roxygen warn when S3 methods are not tagged with @export? #1175

lionel- opened this issue Nov 26, 2020 · 1 comment · Fixed by #1534
Labels
feature a feature request or enhancement namespace 👩‍🚀
Milestone

Comments

@lionel-
Copy link
Member

lionel- commented Nov 26, 2020

It seems like it would help people with internal generics where it is not clear why you need to register. Cf r-lib/devtools#2293.

@hadley
Copy link
Member

hadley commented Apr 16, 2021

I think the biggest question is who's responsibility this is. Should it be roxygen2, devtools, or (maybe) usethis? I guess roxygen2 already has all the machinery to figure out if a function is a S3 method, so it probably makes the most sense here. It could be part of the namespace roclet that would just warn if it spotted unexported methods.

@hadley hadley added feature a feature request or enhancement namespace 👩‍🚀 labels Apr 16, 2021
@hadley hadley added this to the v7.2.4 milestone Nov 2, 2023
hadley added a commit that referenced this issue Nov 16, 2023
And export a bunch of roxygen2 methods thus revealed.

Fixes #1175
hadley added a commit that referenced this issue Nov 21, 2023
* Warn if S3 methods aren't "exported" and export a bunch of roxygen2 methods thus revealed. Fixes #1175
* Improve docs for method "export".  Fixes #1451
jgabry added a commit to stan-dev/bayesplot that referenced this issue Jan 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature a feature request or enhancement namespace 👩‍🚀
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants