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

Why @export restricted to one line? #1669

Open
MichaelChirico opened this issue Oct 14, 2024 · 1 comment
Open

Why @export restricted to one line? #1669

MichaelChirico opened this issue Oct 14, 2024 · 1 comment

Comments

@MichaelChirico
Copy link
Contributor

I would like to write a truly massive @export directive.

{bit64} exports a lot of functions, including every S3 method:

https://github.com/r-lib/bit64/blob/f30bae1787f65e0b4bff9c0dbe2addea5ba58877/NAMESPACE

I would like to explore un-exporting those, but that's a pretty involved project when trying to be considerate of potential breaking changes.

For now, I'd just like to keep the set of exports consistent as I move to {roxygen2}.

The way I'd like to go about that is to put all of these exports that didn't "naturally" wind up with their own @export tag elsewhere in the code base in a single @export tag in bit64-package.R, which I can easily tag with a TODO/bug.

This line would have almost 3,000 characters, though, so I'd like to wrap it. Prepending @export to every line wastes characters and causes visual noise.

AFAIK other tags don't have this restriction so I was surprised to encounter this only with @export.

@mcol
Copy link
Contributor

mcol commented Nov 29, 2024

Have you thought about generating your line programmatically with some inline code?

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

No branches or pull requests

2 participants