878 merge fill_desc and set_options #1040
Merged
Conversation
This file contains hidden or 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
ColinFay
reviewed
May 24, 2023
ilyaZar
force-pushed
the
878-merge-fill_desc-and-set_options
branch
from
15d25fb to
9834cd7
Compare
- defaults to FALSE for retrocompatibility - add documentation informing about future deprecation
- add a note that set_options flag will be TRUE in future golem version but keep the default to FALSE inside 01_start.R and corresponding vignette for the moment
Since set_options=TRUE:
- remove manual setting of set_options=TRUE inside mantests/build.R
- update docs for fill_desc() this param
also: add missing one-liner description for role=c("aut", "cre") inside 01_start.R and a_start.Rmd which is consistent with the short descriptions of the other parameters in these files
ilyaZar
force-pushed
the
878-merge-fill_desc-and-set_options
branch
from
9834cd7 to
5fca427
Compare
ColinFay
reviewed
May 26, 2023
ColinFay
reviewed
May 26, 2023
ColinFay
reviewed
May 26, 2023
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.
Fix #878.
Not sure (since it's been a while ..) if it is still planned to be a breaking change as mentioned in #878 (comment) .
It need not be a breaking change for the moment so here is a "careful" version with a deprecation note for the user in the docs:
Add a new parameter
set_options = FALSEtofill_desc(), soset_golem_options()will not run per default. However,set_golem_options()is run when that flag isTRUE(see commit 1 to this PR).That default
FALSEis set inside files 01_start.R and a_start.Rmd for the user, adding a comment about future deprecation (see commit 2 to this PR).For testing purposes one can
set_options = TRUEin “build.R” (commit 3 to this PR) for some time.