Put JuliaDataScience cheat sheet into docs #4229
Replies: 3 comments
-
We do have this page https://docs.makie.org/stable/examples/plotting_functions/ I'm partial to the titles because often we have multiple different options for input arguments (plus conversions) so it is a little more involved. |
Beta Was this translation helpful? Give feedback.
-
Here are my thoughts: The current examples in the plotting_functions page are neat, but they are not the most basic you can imagine, e.g., the 1st scatter example uses A beginner may want something super simple, to print and put on the wall next to his computer =) Cheat Sheet also allow to have a lot of example in 1 page - no need to navigate a web menu. What I would add to Lazaro Cheat Sheet is 1 or 2 lines on top to give simple example of each argument (e.g., x = [1,2,3], y = [2,5,2], color = :blue, string = "hello", ...) it would of course not produce the figure shown, but it would help a beginner with extremely simple example of what these arguments can be. |
Beta Was this translation helpful? Give feedback.
-
That's a good observation. For me, the docs should be made as accessible as possible. So if the scatter examples are too complicated, we should work to simplify them. And the overview page could also use some polish. A cheat sheet still has its place, but it shouldn't be a remedy for badly structured docs. |
Beta Was this translation helpful? Give feedback.
-
Showing @lazarusA cheat sheet in the docs will be really valuable for first time users.
I imagine, we should inline this into the docs (somewhere close to the startpage), with the titles (e.g. the
scatter(x,y)
) linking to the full code example, and then having a pdf version to download.Hosted here right now: https://juliadatascience.io/datavisMakie_attributes
Source:
https://github.com/JuliaDataScience/JuliaDataScience/blob/main/src/cheatSheet_cairo.jl
https://github.com/JuliaDataScience/JuliaDataScience/blob/main/src/cheatSheet_glmakie.jl
Beta Was this translation helpful? Give feedback.
All reactions