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

Jump to bottom

[DOC] Improve the documentation to better match CRAN requirements #124

Merged
merged 16 commits into from
Oct 27, 2022
Merged

[DOC] Improve the documentation to better match CRAN requirements #124

merged 16 commits into from
Oct 27, 2022

Conversation

csouchet
Copy link
Member

@csouchet csouchet commented Oct 26, 2022 •
edited by tbouffard
Loading

Improve API documentation
Add executable examples

covers #10

@csouchet csouchet added the documentation Improvements or additions to documentation label Oct 26, 2022
@tbouffard tbouffard changed the title [DOC] Update doc [DOC] Improve the documentation to better match CRAN requirements Oct 26, 2022
tbouffard
tbouffard reviewed Oct 26, 2022
View reviewed changes
R/bpmnVisualization.R Outdated Show resolved Hide resolved
@tbouffard tbouffard mentioned this pull request Oct 27, 2022
Merged
csouchet
csouchet commented Oct 27, 2022
View reviewed changes
R/bpmnVisualization.R Outdated Show resolved Hide resolved
csouchet
csouchet commented Oct 27, 2022
View reviewed changes
R/bpmnVisualization.R Outdated Show resolved Hide resolved
R/bpmnVisualization.R Outdated Show resolved Hide resolved
R/bpmnVisualization.R Outdated Show resolved Hide resolved
R/bpmnVisualization.R Outdated Show resolved Hide resolved
R/bpmnVisualization.R Outdated Show resolved Hide resolved
R/bpmnVisualization.R Outdated Show resolved Hide resolved
R/bpmnVisualization.R Outdated Show resolved Hide resolved
R/funs.R Outdated Show resolved Hide resolved
csouchet and others added 3 commits October 27, 2022 09:21
@tbouffard
Copy link
Member

⚠️ let's regenerate the Rd files and push them if needed. There is a risk that they are out-dated comparing to the source code

@csouchet csouchet marked this pull request as ready for review October 27, 2022 08:52
@csouchet csouchet requested a review from tbouffard October 27, 2022 08:52
tbouffard
tbouffard approved these changes Oct 27, 2022
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.

LGTM, good job (in pair 😄)!

@csouchet csouchet merged commit 116ce1f into main Oct 27, 2022
@csouchet csouchet deleted the update_doc branch October 27, 2022 09:26
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

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@csouchet @tbouffard