CycloneDX / CycloneDX/cyclonedx-core-java

Confusing name of `LicenseChoice` class

オープン
#307 コメント 1 件 リアクション 2 件 担当者 0 名 GitHub で見る
主要言語
Java
スター
120
フォーク
90
平均マージ
12時間 43分
マージ済み PR(30日)
18

説明

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?

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

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

調査の方向性

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.

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

評価

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

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

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