JuliaPlots/Plots.jl

`guide` attributes are kind of undocumented

Open

#841 opened on 2017年5月18日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Julia (381 forks)batch import
documentationgood first issue

Repository metrics

Stars
 (1,943 stars)
PR merge metrics
 (平均マージ 3d 12h) (30d で 2 merged PRs)

説明

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.

コントリビューターガイド

調査方針
リポジトリ内の既存のドキュメント構造に慣れてください。属性ページと「guide」属性を見つけてください。「guide」属性（xguide、yguide、zguide）を説明するテーブルを追加し、「label」属性（xlabel、ylabel、zlabel）がエイリアスであることを記載してください。問題 #840 のリンクを参照してください。
技術スタック
julia
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1時間未満
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
GitJuliaDocumentation workflow
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75