matplotlib / matplotlib/matplotlib.github.com

Canonicalization for 're'-inherited methods

オープン
#60 コメント 4 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
言語のデータがありません
スター
29
フォーク
62
PR マージ指標
30日以内にマージされた PR はありません

説明

In 3.4.0, the docs for some Axes methods (pick, pickable, get_picker, set_picker, get_contains, set_contains) were removed. This is because the docs are inherited from the Artist methods.

Sphinx automatically switches all references when generated the docs, but our redirect/canonicalization script here doesn't recognize it. Instead, it thinks these methods were last documented in 3.3.4 and points there.

We should decide if we want to point to the new location (and figure out if it's possible), and do so.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まずリダイレクト/正規化スクリプトを見つけ、継承された Artist メソッドの扱いを Sphinx が生成した参照と比較します。3.4.0 でドキュメントが削除された後、Axes メソッドがどのように表現されているかを確認します。スクリプトがこれらのメソッドを現在の正規の場所に指し示すか、それが不可能であることを明確に記録できれば完了です。

索引モデルが issue の本文から書いたものです。

評価

領域
documentation
issue の種類
ドキュメント
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。