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.

Sign up for GitHub

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

Jump to bottom

Setting environment variable during roxygenise() #1517

Closed
sebffischer opened this issue Oct 13, 2023 · 2 comments
Closed

Setting environment variable during roxygenise() #1517

sebffischer opened this issue Oct 13, 2023 · 2 comments
Labels
feature a feature request or enhancement
Milestone
v7.2.4

Comments

@sebffischer
Copy link

First and foremost, thank you for the great package and your efforts! :)

In the mlr3 project we currently have some issues for which it would help if roxygenise() would set a global environment variable during its lifetime, similar to how pkgdload does it here: https://github.com/r-lib/pkgload/blob/681b36370887b5925304373edbb5e9ea9a87a6dd/R/load.R#L131

We need this environment variable to disable an optimization mechanism we have implemented during package loading, as it prevents the correct generation of R6 docs.
@mllg
Copy link
Member

mllg commented Oct 25, 2023

I would also appreciate this, especially since I see no downside for roxygen2 and the environment variable might also prove useful for future problems.

@hadley
Copy link
Member

hadley commented Nov 1, 2023

Yeah, seems reasonable given that we have so many similar env vars for testthat.

@hadley hadley added feature a feature request or enhancement and removed documentation labels Nov 1, 2023
@hadley hadley mentioned this issue Nov 2, 2023
Merged
@hadley hadley added this to the v7.2.4 milestone Nov 2, 2023
lionel- added a commit to lionel-/roxygen that referenced this issue Nov 6, 2023
@lionel-
Set ROXYGEN_PKG envvar in roxygen setup
aac8a0c 
Closes r-lib#1517
@lionel- lionel- closed this as completed in 4f02838 Nov 6, 2023
sebffischer added a commit to mlr-org/mlr3misc that referenced this issue Nov 15, 2023
@sebffischer
fix(leanify): disable leanification during roxygenise
5ac3677 
roxygen needs srcrefs to generate R6 docs

* r-lib/roxygen2@4f02838
* r-lib/roxygen2#1517
@sebffischer sebffischer mentioned this issue Nov 15, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature a feature request or enhancement
Projects
None yet
Milestone
v7.2.4
Development

No branches or pull requests
3 participants
@hadley @mllg @sebffischer