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

Jump to bottom

check function naming #1598

Closed
jimhester opened this issue Aug 28, 2017 · 6 comments
Closed

check function naming #1598

jimhester opened this issue Aug 28, 2017 · 6 comments
Assignees
@jimhester
Labels
feature a feature request or enhancement

Comments

@jimhester
Copy link
Member

Should we rename build_win() to check_win() and rhub_check() to check_rhub() to make the names more consistent and easier to discover?
@hadley
Copy link
Member

hadley commented Aug 28, 2017

Yes!

@hadley
Copy link
Member

hadley commented Oct 18, 2017

I think we should also have check_win_devel() and check_win_release() just because for the last year I thought build_win() defaulted to "R-devel" (and typically you only want to run one)

@jimhester
Copy link
Member Author

I am not really sure why the code it written as it is, having 'R-release' first in the default argument does make it seem like it would default to 'R-release', but it does default to R-devel

https://github.com/hadley/devtools/blob/a0c8d7333be185f979a60823dcfad66c9f3ea35e/R/build-win.r#L23-L24

Anyway, I agree having separate functions makes sense to me.

@hadley hadley added the feature a feature request or enhancement label Oct 18, 2017
@jimhester jimhester self-assigned this Oct 18, 2017
@hadley
Copy link
Member

hadley commented Oct 18, 2017

Oh that is super confusing!

jimhester added a commit to jimhester/devtools that referenced this issue Oct 18, 2017
@jimhester
Rename build_win to check_win
60ac8f0 
Fixes r-lib#1598
jimhester added a commit to jimhester/devtools that referenced this issue Oct 18, 2017
@jimhester
Rename rhub_check to check_rhub
4ced1a0 
Fixes r-lib#1598
@jimhester jimhester mentioned this issue Oct 18, 2017
Merged
jimhester added a commit to jimhester/devtools that referenced this issue Oct 19, 2017
@jimhester
Rename build_win to check_win
7de9bb8 
Fixes r-lib#1598
jimhester added a commit to jimhester/devtools that referenced this issue Oct 19, 2017
@jimhester
Rename rhub_check to check_rhub
b93f857 
Fixes r-lib#1598
jimhester added a commit to jimhester/devtools that referenced this issue Oct 19, 2017
@jimhester
Rename build_win to check_win
421e923 
Fixes r-lib#1598
jimhester added a commit to jimhester/devtools that referenced this issue Oct 19, 2017
@jimhester
Rename rhub_check to check_rhub
3aa9fc5 
Fixes r-lib#1598
hadley pushed a commit that referenced this issue Oct 19, 2017
@jimhester @hadley
Rename build_win to check_win_* and rename rhub_check to check_rhub (#…
49bf361 
…1626)

* Rename build_win to check_win

Fixes #1598

* Rename rhub_check to check_rhub

Fixes #1598

* Add note to NEWS

* Re-document
@tbates
Copy link

tbates commented Oct 29, 2017 •
edited

Just to note that this is currently backwards incompatible and requires some coding changes in consuming packages. (now getting an error from release check in code updated for dev version).

devtools::check_win()

Missing or unexported object: ‘devtools::check_win’
packageVersion("devtools")
[1] ‘1.13.3’

@lock
Copy link

lock bot commented Sep 17, 2018

This old issue has been automatically locked. If you believe you have found a related problem, please file a new issue (with reprex) and link to this issue. https://reprex.tidyverse.org/

@lock lock bot locked and limited conversation to collaborators Sep 17, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@jimhester jimhester

Labels
feature a feature request or enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@hadley @jimhester @tbates