Add section on inappropriate intimacy between classes

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

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
48/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
python
領域
documentation

調査の方向性

まず、クラス設計またはプロットを扱っているコースドキュメントのセクションを見つけてください。この issue にはファイルやエントリーポイントが記載されていないためです。そこに提供された説明と MIKE IO の例を追加し、公開 API とデータ操作に関するガイダンスを維持してください。新しいセクションが適切なコース教材に公開されれば完了です。

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

説明

Classes should interact through public APIs, not by reaching into each other's private attributes.

Example from MIKE IO plotting refactor:

Before (inappropriate intimacy):

# Plotter reaches into geometry internals for subsetting
values = values[self.da.geometry.top_elements]
geometry = self.da.geometry.geometry2d

# Plotter uses private attribute to check for time axis
if self.da._has_time_axis:
    return self.da.values[0]

After (using public API):

# Use sel/isel for subsetting
da = da.sel(layers="top")
geometry = da.geometry

# Use public dims property
da = self.da.isel(time=0) if "time" in self.da.dims else self.da

Key principles:

  • Never access private attributes (prefixed with _) of another class
  • Use public methods like sel, isel, and public properties like dims
  • If you need to access private state, that's a signal the class is missing a public API
  • Plotters should plot, not subset — keep data manipulation in the data layer
主要言語
Jupyter Notebook
スター
8
フォーク
1
平均マージ
4分
マージ済み PR（30日）
1

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

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

はじめの一歩

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

DHI/python-package-development のほかの issue

DHI/python-package-development の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

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

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