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

Should check() run document on first call? #963

Closed
hadley opened this issue Dec 22, 2019 · 3 comments · Fixed by #1055
Closed

Should check() run document on first call? #963

hadley opened this issue Dec 22, 2019 · 3 comments · Fixed by #1055
Labels
description 📚 feature a feature request or enhancement
Milestone
v1.6.0

Comments

@hadley
Copy link
Member

@hadley hadley commented Dec 22, 2019

Currently, if you create a package and then immediately check it, it does not automatically run document(). But once you've run document() once, check() will automatically run it for you. This seems mildly confusing and worth reconsidering.

Probably related to #927
@jennybc
Copy link
Member

@jennybc jennybc commented Dec 22, 2019

This feels more like a devtools issue.

@hadley
Copy link
Member Author

@hadley hadley commented Dec 23, 2019

It's really to do with how usethis::create_package() initialises the package so I think it belongs here.

@condwanaland
Copy link

@condwanaland condwanaland commented Jan 6, 2020

This trips me up all the time when first creating a package - would strongly be in favor of check() running it on first call

@hadley hadley added description 📚 feature a feature request or enhancement labels Mar 14, 2020
@hadley hadley added this to the v1.6.0 milestone Mar 14, 2020
hadley added a commit that referenced this issue Mar 15, 2020
@hadley
Tweak roxygen2 workflow
6b2d6c1 
* New explicit roxygen argument to create_package(), use_description(), and use_namespace()

* Defaults have been tweaked so that devtools::check() will run document() the first time you call it, and functions will only be exported after you've explicitly exported them

Fixes #927. Fixes #963
@hadley hadley mentioned this issue Mar 15, 2020
Merged
hadley added a commit that referenced this issue Mar 18, 2020
@hadley
Tweak roxygen2 workflow (#1055)
c8d7038 
* New explicit roxygen argument to `create_package()`, `use_description()`, and `use_namespace()`

* Defaults have been tweaked so that `devtools::check()` will run `document()` the first time you call it, and functions will only be exported after you've explicitly exported them

Fixes #927. Fixes #963
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
description 📚 feature a feature request or enhancement
Projects
None yet
Milestone
v1.6.0
Development

Successfully merging a pull request may close this issue.

Tweak roxygen2 workflow r-lib/usethis
3 participants
@hadley @jennybc @condwanaland