ConfigProperties Javadoc does not match getDuration and getMap behavior
Los mantenedores suelen responder en 2 días
Ya se ha fusionado un pull request relacionado.
Evaluación
- Dificultad
- 1/5
- Tiempo estimado
- Menos de una hora
- Aptitud para principiantes
- 94/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- java
- Área
- documentation
Línea de trabajo
Comienza en sdk-extensions/autoconfigure-spi, en ConfigProperties.java, y revisa el Javadoc de los tres métodos mencionados. Compara el comportamiento documentado con DefaultConfigProperties.getDuration y las aserciones de ConfigPropertiesTest. Se considera terminado cuando el Javadoc describe correctamente los errores, las unidades admitidas y los valores de retorno sin cambiar el comportamiento ni las firmas.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Is your feature request related to a problem? Please describe.
The Javadoc of the stable ConfigProperties SPI does not match how the default implementation behaves:
getDuration(String)says it returnsnullif the property "has a wrong type". Its own@throwssays malformed values throw, andDefaultConfigProperties.getDurationthrowsConfigurationExceptionfor a bad number or unit (asserted inConfigPropertiesTest). A custom implementation that follows the first sentence would silently fall back to defaults.- The
getDuration(String)unit list omitsnsandus, whichDefaultConfigPropertiesaccepts. - The
@returnofgetDuration(String, Duration)andgetMap(String, Map)says "a Double-valued configuration property", copied fromgetDouble(String, double).
Describe the solution you'd like
Correct the three points above in ConfigProperties.java. Javadoc only; no behavior or signature change.
Describe alternatives you've considered
N/A
Spec alignment
N/A — Java SPI documentation only.
Additional context
- Affected module:
:sdk-extensions:autoconfigure-spi - Artifact stability: stable
- Backward compatible: yes
- Lenguaje dominante
- Java
- Estrellas
- 2.5k
- Forks
- 1k
- Merge medio
- 3 d 15 h
- PR fusionados (30 d)
- 65
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de open-telemetry/opentelemetry-java
-
OkHttpGrpcSender no longer logs retry attemptsPosiblemente ocupada @thswlsqls la tomó hace 6 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
open-telemetry/opentelemetry-java#8966 · 1 reacción ·
Los mantenedores suelen responder en 2 días
-
JdkHttpSender passes CompletionException instead of the original exception to onErrorPosiblemente ocupada @thswlsqls la tomó hace 7 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
open-telemetry/opentelemetry-java#8961 · 1 reacción ·
Los mantenedores suelen responder en 2 días
-
Fix `otel.sdk.log.created` counting semanticsPosiblemente ocupada @anuraaga la tomó hace 80 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
open-telemetry/opentelemetry-java#8688 ·
Los mantenedores suelen responder en 2 días
-
Feature Request
Dificultad 5/5 Más de una semana Aptitud para principiantes 44/100
open-telemetry/opentelemetry-java#8976 · 2 comentarios ·
Los mantenedores suelen responder en 2 días
-
Workflow failed: Build (daily) (#323)Posiblemente ocupada @breedx-splk la tomó hace 3 días. Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 25/100
open-telemetry/opentelemetry-java#8972 · 5 comentarios ·
Los mantenedores suelen responder en 2 días
Todos los issues de open-telemetry/opentelemetry-java
Issues similares
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
AllTheMods/AllTheModium#238 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
apache/stormcrawler#2264 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 77/100
commons-app/apps-android-commons#7115 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
objectionary/lints#1596 ·
Los mantenedores suelen responder en 2 días