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.

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(R): improve installation guide #93

Merged
merged 10 commits into from
Oct 6, 2021
Merged

Conversation

tbouffard
Copy link
Member

@tbouffard tbouffard commented Sep 6, 2021

Improve the package installation, in particular, how to install rJava.
Also explain how to display the BPMN Diagram with the bpmnVisualization package.
Fix the data in the usage example, it generated a NullPointerException in the
java code that was very hard to debug.
Robustness: print the java stack trace to make debugging easier

Closes #91
Closes #92

For reviewer

Please test the package with both valid and invalid data (use the previous example for instance)

@tbouffard tbouffard added the documentation Improvements or additions to documentation label Sep 6, 2021
@tbouffard tbouffard marked this pull request as ready for review September 8, 2021 06:58
Copy link
Member

@csouchet csouchet left a comment

Choose a reason for hiding this comment

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

I follow the new documentation to install & use it with bpmnVisualization => 👍🏻

@csouchet csouchet added the hacktoberfest-accepted Accepted Pull Request during Hacktoberfest label Oct 6, 2021
@tbouffard tbouffard merged commit aa254ec into master Oct 6, 2021
@tbouffard tbouffard deleted the doc/91-fix_installation_guide branch October 6, 2021 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hacktoberfest-accepted Accepted Pull Request during Hacktoberfest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[R package] Explain how to visualize the BPMN diagram [R package] Review package installation instruction
2 participants