Git Product home page Git Product logo

Comments (8)

BeastyBlacksmith avatar BeastyBlacksmith commented on August 25, 2024 2

After thinking about this for a while I think the best place would be to change https://github.com/JuliaPlots/Plots.jl/blob/master/src/arg_desc.jl to be a Vector{NamedTuple} with attribute, docstring, example fields.
This way the examples can also be shown by the plotattr function in the REPL and then we only need a good place in the docs to create and render all the figures.

from plotdocs.jl.

BeastyBlacksmith avatar BeastyBlacksmith commented on August 25, 2024

That depends on whether these links should also be displayed when people use the plotattr function from the REPL.
I don't think it is a good idea to store directly the URLs in that dict.
Maybe its good to store the numbers of the examples in that dict and generate the links at documentation build time.

That may get forgotten when new examples get added, but would be less complex than extracting from the examples what attributes got used.

from plotdocs.jl.

logankilpatrick avatar logankilpatrick commented on August 25, 2024

That works for me, I don't want to add things to your place but I am happy to find all the example projects and link them if you or someone else set's up the hooks for the links to be generated at build time.

from plotdocs.jl.

BeastyBlacksmith avatar BeastyBlacksmith commented on August 25, 2024

We might need to clarify what you mean by "example links". I thought we are talking about these. For examples in other packages we have the ecosystem section

from plotdocs.jl.

logankilpatrick avatar logankilpatrick commented on August 25, 2024

All I mean by "example links" is a link on each attribute a user can click on and then see said attribute in action. This will hopefully serve as a way to bridge the theoretical and practical in this content.

from plotdocs.jl.

BeastyBlacksmith avatar BeastyBlacksmith commented on August 25, 2024

I am still confused whether those links should point to the existing examples page, to examples that are created for that purpose or to examples that are somewhere in the wild.

from plotdocs.jl.

logankilpatrick avatar logankilpatrick commented on August 25, 2024

I think existing examples within the docs is probably better so we don't need to worry about external links disappearing. I'm guessing all of the attributes may not be present in the current docs but I (or others) can add examples or add the attributes to existing examples.

from plotdocs.jl.

BeastyBlacksmith avatar BeastyBlacksmith commented on August 25, 2024

I see. This sounds like a useful idea. For this purpose it would make sense to generate these examples in this repository since the existing examples test many different things at once since they are used for the visual regression tests.
But for such reference examples it would actually be better to show the effect of each attribute in isolation or useful context.

from plotdocs.jl.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.