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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Oct 11, 2021
Merged

[DOC] Remove duplicated words in function documentation #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1ea4f56
Remove words duplicated on R-Doc (?) :)
alachambre Oct 11, 2021
0d108b4
Merge branch 'main' into patch-1
tbouffard Oct 11, 2021
54a1165
Regenrate documentation
Oct 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ URL: https://github.com/process-analytics/bpmn-visualization-R
BugReports: https://github.com/process-analytics/bpmn-visualization-R/issues
Encoding: UTF-8
LazyData: true
RoxygenNote: 7.1.1
RoxygenNote: 7.1.2
Imports:
htmlwidgets,
xml2
2 changes: 1 addition & 1 deletion R/bpmnVisualization.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏻 Good catch 😆

Copy link
Contributor Author

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? :'(

Copy link
Member

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.

Copy link
Contributor Author

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 ^^

Copy link
Member

@csouchet csouchet Oct 11, 2021 •
edited
Loading

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.

Copy link
Member

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

Copy link
Member

@csouchet csouchet Oct 11, 2021 •
edited
Loading

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.

#' @param label HTML element to use as an overlay
#'
#' @return An overlay object
#'
Expand Down
2 changes: 1 addition & 1 deletion man/create_overlay.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.