-
Notifications
You must be signed in to change notification settings - Fork 4
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
[DOC] Remove duplicated words in function documentation #53
Conversation
@@ -68,7 +68,7 @@ display <- function(bpmnXML, overlays = NULL, width = NULL, height = NULL, eleme | |||
#' Use this structure to create correct overlay structure. | |||
#' | |||
#' @param elementId The bpmn element id to which the overlay will be attached | |||
#' @param label HTML element to use as an overlay to use as an overlay |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍🏻 Good catch 😆
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So it is not called R-Doc? :'(
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, the "R documentation" (Rd) format is generated from the function comments thanks to roxygen2.
So what you changed is not exactly R-Doc 😸
That being said, the Pull Request is incomplete: the related .Rd file stored in the man
folder must be regenerated as well. This is a pain 😿 , and we are aware of this #30
I can handle it if you want.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm interested to do it, but i'm a bit lost, which kind of IDE should I use to develop and build this R package?
I'm familiar with the R console to do mathematics stuff but that's it. I opened the project in vs-code, it's fine to write code but nothing more ^^
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is some plugin to use R in IntelliJ (maybe in VS Code), but to have a complete integration, we use R Studio.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For VSCode, you can use https://marketplace.visualstudio.com/items?itemName=Ikuyadeu.r
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@alachambre By using the command devtools::document()
, the documentation is regenerated.
@tbouffard I'll update the readme & the contributing guide to add this command.
ℹ️ we currently have an issue when building with the R-devel which is not related to the change proposed here.
I am going to disable building on R-devel in a dedicated PR and we should be able to merge this one afterwards. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @alachambre
No description provided.