JuliaPlots/Plots.jl

`guide` attributes are kind of undocumented

Open

#841 opened on May 18, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Julia (381 forks)batch import
documentationgood first issue

Repository metrics

Stars
 (1,943 stars)
PR merge metrics
 (Avg merge 3d 12h) (2 merged PRs in 30d)

Description

The guide attributes, xguide, yguide, and zguide do not show up on the attributes page. Interestingly, the label versions, like xlabel do. This makes it seem like xlabel is the true attribute. However, the label attributes are actually just aliases for the guide attributes. This can lead users to subtle issues, like https://github.com/JuliaPlots/Plots.jl/issues/840 .

The fix is to add a table to the docs which explains the guide attributes, along with naming its aliases.

Contributor guide

Research direction
Familiarize yourself with the existing documentation structure in the repo. Locate the attributes page and the 'guide' attributes. Add a table explaining the 'guide' attributes (xguide, yguide, zguide) and note that 'label' attributes (xlabel, ylabel, zlabel) are aliases. Reference the link to issue #840.
Tech stack
julia
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJuliaDocumentation workflow
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75