CycloneDX / CycloneDX/cyclonedx-core-java

Confusing name of `LicenseChoice` class

Đang mở
#307 1 bình luận 2 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Java
Star
120
Fork
90
Merge trung bình
12 giờ 43 phút
Pull request đã merge (30 ngày)
18

Mô tả

I'm continuously stumbling over

https://github.com/CycloneDX/cyclonedx-core-java/blob/79b808f5a77b6f6465d649761974841293887f99/src/main/java/org/cyclonedx/model/LicenseChoice.java#L31

To me, the name of the class sounds as if it would implement a choice mechanism that for example says "whenever you encounter the SPDX license expression `MIT OR BSD`, choose `MIT`". But actually, no "choice" seems to be involved here at all, and the class simply holds a list of license objects and / or its belonging SPDX license expression string.

So, where does "Choice" in the class name come from? Does it make sense to clarify this in the class docs?

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

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Read src/main/java/org/cyclonedx/model/LicenseChoice.java around line 31 and compare the class name with its documented role of holding license objects and/or an SPDX license expression. Done means the class documentation clearly explains the meaning of “Choice” or the naming concern is resolved; the issue has no test location mentioned.

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

Đánh giá

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

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.