Skip to content

[DOC] Remove duplicated words in function documentation #53

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

Jump to bottom
Merged
tbouffard merged 3 commits into from
Oct 11, 2021
Merged

[DOC] Remove duplicated words in function documentation #53

tbouffard merged 3 commits into from
Oct 11, 2021

Conversation

@alachambre
Copy link
Contributor

@alachambre alachambre commented Oct 11, 2021

No description provided.

csouchet
csouchet reviewed Oct 11, 2021
View reviewed changes
R/bpmnVisualization.R
#' 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
Contributor

@csouchet csouchet Oct 11, 2021

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

@alachambre alachambre Oct 11, 2021

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

@tbouffard tbouffard Oct 11, 2021

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

@alachambre alachambre Oct 11, 2021

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
Contributor

@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

@tbouffard tbouffard Oct 11, 2021

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
Contributor

@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.

@tbouffard tbouffard changed the title Remove words duplicated on R-Doc (?) :) [DOC] Remove duplicated words in function documentation Oct 11, 2021
@tbouffard
Copy link
Member

tbouffard commented Oct 11, 2021

ℹ️ we currently have an issue when building with the R-devel which is not related to the change proposed here.

Error: Error in loadNamespace(x) : there is no package called ‘rcmdcheck’
Calls: loadNamespace -> withRestarts -> withOneRestart -> doWithOneRestart
Execution halted

I am going to disable building on R-devel in a dedicated PR and we should be able to merge this one afterwards.

@tbouffard tbouffard added documentation Improvements or additions to documentation hacktoberfest-accepted Accepted Pull Request during Hacktoberfest labels Oct 11, 2021
@tbouffard tbouffard mentioned this pull request Oct 11, 2021
Merged
tbouffard
tbouffard approved these changes Oct 11, 2021
View reviewed changes
Copy link
Member

@tbouffard tbouffard left a comment

Choose a reason for hiding this comment

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

Thanks @alachambre

@tbouffard tbouffard merged commit efa602c into process-analytics:main Oct 11, 2021
@tbouffard tbouffard added the external contribution 👤 Pull requests provided by someone who is not a core maintainer label Oct 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tbouffard tbouffard tbouffard approved these changes

+1 more reviewer

@csouchet csouchet csouchet left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation external contribution 👤 Pull requests provided by someone who is not a core maintainer hacktoberfest-accepted Accepted Pull Request during Hacktoberfest

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@alachambre @tbouffard @csouchet