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

Fix recipe docs #1448

Merged
merged 2 commits into from
Dec 10, 2021
Merged

Fix recipe docs #1448

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87ddec5
Fix code block
jonas-schulze Nov 16, 2021
8495860
Fix typo
jonas-schulze Nov 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/documentation/recipes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,9 @@ myplot!(args...; kw_args...) = ...
A specialization of `argument_names` is emitted if you have an argument list
`(x,y,z)` provided to the recipe macro:

`argument_names(::Type{<: MyPlot}) = (:x, :y, :z)`
```julia
argument_names(::Type{<: MyPlot}) = (:x, :y, :z)
```

This is optional but it will allow the use of `plot_object[:x]` to
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Later on in the stocks example, the arguments are fetched like plot_object.x. Is both supported or should the above be changed to match the example?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer plot.x and would like to deprecate plot[:x] at some point, or change its meaning...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I change this in the docs to bridge the gap while you are working on the overhaul? I couldn't find where plot.x get's wired into getproperty, so I didn't feel comfortable doing the change right away. Here are some other occurences:

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, somehow missed your comment... Yeah I think that's a good idea!

Its here: https://github.com/JuliaPlots/Makie.jl/blob/78820311c9b45347f0937caf8b31a25bbc27dd73/MakieCore/src/attributes.jl#L189

And then getproperty uses getindex here:
https://github.com/JuliaPlots/Makie.jl/blob/78820311c9b45347f0937caf8b31a25bbc27dd73/MakieCore/src/attributes.jl#L83
(Not very straightforward to find, especially with the Transformable supertype)

fetch the first argument from the call
Expand All @@ -111,10 +113,10 @@ will provide `plot_object[:arg1]` etc.

The theme given in the body of the `@recipe` invocation is inserted into a
specialization of `default_theme` which inserts the theme into any scene that
plots `Myplot`:
plots `MyPlot`:

```julia
function default_theme(scene, ::Myplot)
function default_theme(scene, ::MyPlot)
Theme(
plot_color => :red
)
Expand Down