CycloneDX / CycloneDX/cyclonedx-core-java

Confusing name of `LicenseChoice` class

Abierto
#307 1 comentario 2 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
Java
Estrellas
120
Forks
90
Merge medio
12 h 43 min
PR fusionados (30 d)
18

Descripción

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?

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
java
Área
documentation
Tipo de issue
Documentación
Dificultad
1/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.