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

box types not named consistently

Đang mở
  • Có gì không ổn?
#220 6 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ó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
30/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
tooling

Hướng nghiên cứu

Bắt đầu bằng việc xem xét các định nghĩa kiểu Box hiện có và các đối số kiểu được ghi trong tài liệu của chúng. Issue đề xuất các tên theo dạng tính từ-danh từ, các bí danh đã lỗi thời cho những tên cũ và có thể là việc tạo lớp con của Box, nhưng thiết kế được ưu tiên vẫn chưa được quyết định. Để hoàn tất, cần có quyết định của maintainer, sau đó là các thay đổi tương ứng đối với API và tài liệu.

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

Mô tả

enhancement wontfix

I always prefer class/type naming to be "adjective noun" as opposed to "noun adjective", which some prefer because filenames group together. "Adjective noun" matches normal speech, such as "hand me the blue pen".

When I first looked at box types I had to take time to understand what they meant, because my first reaction what "what is different to name one camel_killer_box and another box_dots".

I suggest that names be change to:

  • conversion_box
  • default_box
  • dots_box
  • camel_killer_box
  • frozen_box
  • recast_box
  • intact_types_box
    and allow previous names as synonyms for a time, marked with a deprecated warning.

However, I wonder why you didn't subclass box instead. You are calling the above type arguments.
Sub-classing Box would also have the benefit of

  • making it more explicit that it is a different type with some additional behavior
  • allow parameters specific to the sub-class to be specific to the init for that class
    • it is clear from the documentation that supplemental box arguments are specific to the type of box

Would you accept a pull request for this?

Ngôn ngữ chính
Python
Star
2.8k
Fork
145
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

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 cdgriffith/Box

Tất cả issue của cdgriffith/Box

Issue tương tự

Thêm issue về Python

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.