JuliaPlots/Plots.jl

Documentation

Open

#83 opened on Nov 22, 2015

View on GitHub
 (45 comments) (0 reactions) (0 assignees)Julia (1,943 stars) (381 forks)batch import
documentationgood first issuehelp wantedpriority

Description

Here's the TODO list... I'll add/change as appropriate:

Concept pages

  • Colors, ColorGradients (how and when to use what, what kinds of things are supported, lots of examples, also point to external sources for predefined gradients. see: #139)
  • Input data (vectors, matrices, functions, dataframes, tuples, custom objects... talk about all the ways to pass in data and how it gets passed through the pipeline)
  • Arguments (vector vs matrix, preprocessing pipeline, magic args, etc)
  • Subplots (different ways to build, layout types, linked axes)
  • Backends (How to choose... which ones are good at different plot types, some prose about the quality/progress for each package, some side-by-side comparisons of plot examples)
  • Fonts, PlotText, Annotations
  • Guides (titles, axis labels/limits/ticks, legend/colorbar)
  • Plot components (path vs line, markers, fills, styles, strokes, shapes, etc) (see #445 for additional ideas)
  • Animations
  • Recipes (some examples of how to plot custom objects, or to build predefined sequences. discuss both PlotRecipe and _apply_recipe and when you would use either and why they are so much better than making a function that wraps a call to plot)
  • Design decisions (why did I make certain decisions, thoughts on speed, thoughts on different usage patterns, thoughts on why there are many ways to do the same thing, how MLPlots/ExamplePlots fit into the ecosystem)
  • Goals for the future (Make Plots... ???... profit)

Examples

  • Better/more complex examples covering more functionality
  • Output other than PNG... for example GR could be SVG, Plotly should be HTML

Tutorials

  • Reorganize notebooks directory in ExamplePlots into tutorials and scratch. (most of them will be scratch currently.) The idea is that these will be "true tutorials" and not just haphazard code. They should combine Plots with some real world workflows and have lots of comments/structure

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.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with Plots.jlBasic documentation writing skills
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Focus on one of the unchecked items in the TODO list, such as 'Fonts, PlotText, Annotations' or 'Plot components'. Review the existing documentation structure in the Plots.jl repository. Refer to related issues #139 and #445 mentioned in the body. Check the 45 comments for any updates or decisions made by maintainers to ensure alignment with current project direction.