feat(style)!: refactor how to build the overlay style #245
Conversation
- 'create_style' becomes 'create_overlay_style'
csouchet
added
documentation
|
♻️ PR Preview b561330 has been successfully destroyed since this PR has been closed.
🤖 By surge-preview |
There was a problem hiding this comment.
refactor!: simplify the construction of the overlay style for the PR title.
The commit used to merge the PR must also mention it and the release notes as well.
See https://www.conventionalcommits.org/en/v1.0.0/#commit-message-with-both--and-breaking-change-footer
I don't know how breaking changes have to be handled in the R ecosystem. This is something that should be checked IMHO.
I don't see any problem for introducing breaking changes in general. Can you please give me an example of the future "style update" functions to let me understand how the refactoring help for the new API?
In parallel, I am reviewing the details of the code changes.
| @@ -38,35 +38,38 @@ | |||
| #' # Load the BPMN file | |||
| #' bpmn_file <- system.file("examples/Order_Management.bpmn", package = "bpmnVisualizationR") | |||
| #' | |||
| #' # Display the BPMN diagram | |||
| #' # Example 1: Display the BPMN diagram | |||
There was a problem hiding this comment.
praise: Nice, this makes things easier to understand when reading the documentation.
| #' Refer to the \code{font} parameter in the \code{\link{create_style}} function for more information. | ||
| #' | ||
| #' Use this function to create the correct font structure for an overlay. | ||
| #' - Overlay: |
There was a problem hiding this comment.
question: I guess this is added to prepare the new "update style" API?
csouchet
changed the title
csouchet
changed the title
csouchet
force-pushed
the
refactor_how_to_build_the_overlay_style
branch
from
c51164c
to
41db251
Compare
tbouffard
added
enhancement
To address issue #13 efficiently and avoid creating separate functions for creating
font,fillandstrokestyles foroverlay,edgeandshape, I refactored the existing code.As part of this refactoring, I've converted the
create_font,create_fillandcreate_strokefunctions to internal functions.This enhancement allows these functions to accept additional parameters as needed. The responsibility for passing the appropriate parameters to these functions now rests with the functions dedicated to overlays (
create_overlay_style), edges, and shapes.BREAKING CHANGE:
create_font,create_fillandcreate_strokefunctions are internal functions.create_stylehas been renamed increate_overlay_style, and now, we use only this function to create the style of an overlay.