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 (1,943 stars) (381 forks)batch import
documentationgood first issue

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

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.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue requests adding a table to the documentation that explains the `guide` attributes (`xguide`, `yguide`, `zguide`) and their aliases (`xlabel`, etc.). First, locate the documentation source for attributes (likely in the Plots.jl docs folder, e.g., `docs/src/attributes.md`). Then, add a subsection for guide attributes, clearly listing each attribute and its alias. The table should follow the existing format used for other attributes. Reference the linked issue #840 for context about user confusion.