Clean up recipe kwargs#32
Merged
Merged
Conversation
Member
Author
|
The |
There was a problem hiding this comment.
Pull request overview
This PR refactors plotting recipe keyword arguments to reduce confusion around :samplemarkers, primarily by deprecating sampmarks and introducing clearer showline / showmarks keywords, with accompanying documentation/example updates.
Changes:
- Updated the
:samplemarkersrecipe to better handle “line off” vs “markers off” scenarios by conditionally adding line/marker series. - Deprecated
sampmarksin multiple user recipes and mapped it to the new keywords viaBase.depwarn. - Updated docs/examples to use the new keyword arguments and adjusted some narrative text.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| src/recipes.jl | Refactors :samplemarkers internals; introduces showline/showmarks; deprecates sampmarks; updates recipe docs and examples. |
| docs/example/utilities.jl | Updates example plot call to new keyword usage. |
| docs/example/fitting_rf_mannitol.jl | Updates example plot call and adds explanatory comments for PD end detection. |
| docs/example/fitting_mannitol.jl | Switches PD end detection mode used in the example. |
| docs/example/all_recipes.jl | Updates recipe examples to use showline/showmarks instead of sampmarks. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or 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
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.
I've been bothered for a while by the workarounds for taking markers off when using the
:samplemarkersrecipe type, and when to use or not use thesampmarkskwarg in recipes on top of it. Still deciding what a reasonable API is.