Adding addin for document(). #2188
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
Member
|
Thanks! |
sthagen
added a commit
to sthagen/r-lib-devtools
that referenced
this pull request
Feb 14, 2020
Adding addin for document(). (r-lib#2188)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Rstudio can be used to document a package with a keyboard shortcut (CTRL/CMD+ALT+D) and a few settings under Project Options -> Build Tools -> Generate documentation with Roxygen. Unfortunately it is not possible to get it to run
devtools::document()without any arguments which is useful as it uses the settings (roclets) given in theDESCRIPTIONfile as desired when usingroxygen2extensions as e.g. https://github.com/mikldk/roxytest.One solution would be to get this functionality directly in Rstudio, but that seems to be difficult: rstudio/rstudio#5201.
This simple addin would be a simple way to achieve the same.