matplotlib / matplotlib/matplotlib

[MNT]: Clarify whether the values of an AxesImage are known as "data" or as "array"

オープン
#28,929 コメント 13 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

API: consistency Maintenance
主要言語
Python
スター
23.2k
フォーク
8.5k
平均マージ
1日 6時間
マージ済み PR(30日)
66

説明

### Summary

The docstring of `AxesImage.set_array` says "Retained for backwards compatibility - use set_data instead.", but on the getter side, only `get_array` (inherited from ScalarMappable) exists -- `get_data` doesn't even exist.

### Proposed fix

Be consistent as to which name, "data" or "array", is used. I suspect they could even be made aliases of one another at the ScalarMappable level...
(Perhaps also distantly related to the colorizer-related API changes.)

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

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

はじめの一歩

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

調査の方向性

まず AxesImage.set_array の docstring と ScalarMappable.get_array を比較し、issue で言及されている colorizer 関連の API 変更との関係の可能性を確認します。これらの値についてプロジェクトとして一貫した命名規則が決定され、関連する getter/setter の動作とドキュメントがその決定を反映していれば完了です。

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

評価

技術スタック
python
領域
api, data-visualization
issue の種類
リファクタリング
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

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

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