JuliaPlots/Plots.jl

`guide` attributes are kind of undocumented

Open

#841 opened on 2017年5月18日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Julia (1,943 stars) (381 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.