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.

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

Add areaplot example to gallery #4178

Merged
merged 2 commits into from
Apr 19, 2022
Merged

Conversation

briochemc
Copy link
Collaborator

Not sure this is the right way to add example to the gallery but hopefully this is helpful :)

Not sure this is the right way to add example to the gallery but hopefully this is helpful :)
@t-bltg t-bltg added the gallery label Apr 12, 2022
@t-bltg
Copy link
Member

t-bltg commented Apr 12, 2022

@BeastyBlacksmith (or @johnnychen94), what is the criterion for orienting contributions to the new gallery (old examples) or the user gallery ?

@johnnychen94
Copy link
Contributor

johnnychen94 commented Apr 13, 2022

Here's my understanding:

  • For examples that can be fit into the docstring, it goes here (the old examples); these examples have no differences from the examples listed in ?startswith and it simply indicates that these functionalities work or don't work for certain backends.
  • The new gallery is more of a "how to make a beautiful plot result" collection; it doesn't necessarily work for every backend.

For this specific PR, I think it should be here.

@briochemc
Copy link
Collaborator Author

FWIW, I submitted this because someone on StackOverflow "looked at all of the examples in the documentation and could not find a similar graph" (similar to an areaplot).

@t-bltg
Copy link
Member

t-bltg commented Apr 14, 2022

Good point for the docstring. We could say that the examples working with all major backends GR, Plotly, PyPlot, PGFPlotsX are allowed to go into the regular Gallery.

So @briochemc for this PR to go in you'd need to:

  1. stick to the format (run using JuliaFormatter; format(["src", "test"]))
  2. generate the new reference images for gr by running the test suite, and submitting a pr to https://github.com/JuliaPlots/PlotReferenceImages.jl (see also https://docs.juliaplots.org/stable/contributing/#VisualRegressionTests).

@codecov
Copy link

codecov bot commented Apr 19, 2022

Codecov Report

Merging #4178 (35247d4) into master (4f9a708) will increase coverage by 0.08%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #4178      +/-   ##
==========================================
+ Coverage   77.55%   77.64%   +0.08%     
==========================================
  Files          28       28              
  Lines        7054     7054              
==========================================
+ Hits         5471     5477       +6     
+ Misses       1583     1577       -6     
Impacted Files Coverage Δ
src/examples.jl 96.77% <ø> (ø)
src/axes.jl 85.26% <0.00%> (-0.23%) ⬇️
src/backends/gr.jl 89.01% <0.00%> (-0.09%) ⬇️
src/args.jl 74.39% <0.00%> (+0.15%) ⬆️
src/recipes.jl 64.23% <0.00%> (+0.77%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4f9a708...35247d4. Read the comment docs.

@BeastyBlacksmith BeastyBlacksmith merged commit 182d468 into JuliaPlots:master Apr 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants