Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Add section on inappropriate intimacy between classes

Đang mở
#35 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
48/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách xác định phần trong tài liệu khóa học đề cập đến thiết kế lớp hoặc việc vẽ biểu đồ, vì issue không nêu tên tệp hay điểm bắt đầu. Thêm phần giải thích được cung cấp và các ví dụ về MIKE IO vào đó, đồng thời giữ nguyên hướng dẫn về các API công khai và thao tác dữ liệu; công việc được coi là hoàn tất khi phần mới được xuất bản trong tài liệu khóa học phù hợp.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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
Ngôn ngữ chính
Jupyter Notebook
Star
8
Fork
1
Merge trung bình
4 phút
Pull request đã merge (30 ngày)
1

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của DHI/python-package-development

Tất cả issue của DHI/python-package-development

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.