JuliaPlots/Plots.jl

`guide` attributes are kind of undocumented

Open

#841 建立於 2017年5月18日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Julia (1,943 star) (381 fork)batch import
documentationgood first issue

描述

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.

貢獻者指南

技術棧
無
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
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.