Enable showable overrides per diagram type #62
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This both saves on some typing, requires less instances to have to be created and makes it slightly easier to read the tests.
`Kroki` tries to select the most suitable output format to render a diagram in using Julia's `Base.show` and `AbstractDisplay` capabilities. Situations may occur where the "best" output format that gets determined is not actually the "best" output format. This new functionality enables control over which output formats will be used by `Base.show`, in particular allowing specific output formats to be disabled. This approach prevents the need for having to explicitly construct a `Diagram` and `render`ing it and will also work when defining diagrams using the string literals. This is technically not a breaking change. However, given that the overall API of this package has proven stable over a long period of time this addition is a good point in time to move to v1.y.z. Closes #51.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## development #62 +/- ##
=============================================
Coverage 100.00% 100.00%
=============================================
Files 5 5
Lines 146 157 +11
=============================================
+ Hits 146 157 +11 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Krokitries to select the most suitable output format to render a diagram in using Julia'sBase.showandAbstractDisplaycapabilities. Situations may occur where the "best" output format that gets determined is not actually the "best" output format.This new functionality enables control over which output formats will be used by
Base.show, in particular allowing specific output formats to be disabled. This approach prevents the need for having to explicitly construct aDiagramandrendering it and will also work when defining diagrams using the string literals.This is technically not a breaking change. However, given that the overall API of this package has proven stable over a long period of time this addition is a good point in time to move to v1.y.z.
Closes #51.