JuliaPlots/Plots.jl

Add some developer docs

Open

#5,686 opened on Mar 4, 2020

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Julia (1,943 stars) (381 forks)batch import
documentationenhancementhelp wanted

Description

@mkborregaard generated an awesome graph of method calls for histogram here, and it would be nice if we could include that in the docs. We could also look into using D3Trees.jl and building interactive tree visualizations for some plot calls; the code used to generate this PDF is at https://gist.github.com/mkborregaard/81825c3d370bb4d8dbfe59c3b2ae4b33.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Julia programmingPlots.jl basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests adding a method call graph PDF (from the linked gist) to the Plots.jl developer documentation. Additionally, investigate using D3Trees.jl to create interactive tree visualizations of plot calls. Start by reviewing the existing documentation structure in the PlotDocs.jl repository and the code in the gist.