-
-
Notifications
You must be signed in to change notification settings - Fork 50
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
update roxygen skeleton with return+examples #22
Conversation
Hi, Please make sure to follow the contribution guidelines and provide/update tests. If you want I can do the tests for you. Can you more explain about |
Didn't realize that playground wasn't tests 😳
Sorry about that! I'm a bit new to developing and testing vim plugins, and I accidentally updated the playground instead of the actual tests! 😅 I attempted to update the tests in a6b048b, but they still don't pass and I'm not quite sure how to load the development plugin to use the playground.
Certainly. The examples is just an open field for adding quick examples of how the function should run. They aren't strictly necessary when not developing a package, but it is good practice to include at least one small example. Besides, it's what RStudio includes by default for their doc skeleton, so I figured, why not? ᕕ( ᐛ )ᕗ |
No worries. I'll fix the tests for you.
Okay, I'll add it for now since you're ATM the only one requesting some changes for the R language. |
I've fixed the tests. You were almost there. I did change
into
where I remove the additional |
Thank you for the help! Regarding the comment in front of the TODO: either way works! Regarding the indentation of examples: it is not necessary. For example, the ggplot2 package does not indent the examples: #' @examples
#' aes(x = mpg, y = wt)
#' aes(mpg, wt)
#'
#' # You can also map aesthetics to functions of variables
#' aes(x = mpg ^ 2, y = wt / cyl) |
Your contribution has been released as v1.5.3. Feel free to submit any new issues if you experience any unwanted behaviour in the future. Thanks for your contribution. |
Thank you for making this plugin with clear documentation and also for being patient! |
Prelude
Thank you for helping out DoGe!
By contributing to DoGe you agree to the following statements (Replace
[ ]
with[x]
with those you agree with):Why this PR?
This provide the return and examples fields, which are both good practice, necessary for package development, and are the defaults provided by RStudio's shortcut.
By the way, I really like how this plugin "just works" ^_^