Add Makie package extension #51
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #51 +/- ##
==========================================
- Coverage 98.85% 98.80% -0.06%
==========================================
Files 20 21 +1
Lines 1838 1840 +2
==========================================
+ Hits 1817 1818 +1
- Misses 21 22 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
ranocha
reviewed
Apr 5, 2024
ranocha
reviewed
Apr 5, 2024
ranocha
reviewed
Apr 5, 2024
Co-authored-by: Hendrik Ranocha <[email protected]>
sloede
requested changes
Apr 8, 2024
Co-authored-by: Michael Schlottke-Lakemper <[email protected]>
ranocha
approved these changes
Apr 9, 2024
sloede
approved these changes
Apr 9, 2024
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.
Create a package extension for the plotting functionality implemented herein that requires Makie.jl to be loaded. To remain backwards compatible with Julia v1.6, I've kept the current approach that is based on Requires.jl.
When a Julia version above 1.9.1 is used, the package extension is loaded instead of relying on Requires.jl. The only user-visible difference is that we define "empty" functions for
plotProject!andupdatePlot!in HOHQMesh.jl that are then exported, since the package extension cannot export anything itself.I tested it locally using Julia versions 1.10.0 and 1.8.5 and everything passed.
I was not sure where the docstrings for the functions should live. Right now they are on the actual functions contained in the package extension but they might need moved.I had to place the docstings above the functions insrc/Viz/visualization.jlfor them to show up properly in the docs. So, I added a note in the docstrings pointing to where the full function is actually implemented.