Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

ConfigProperties Javadoc does not match getDuration and getMap behavior

Chiusa Adatta ai principianti
  • Qualcosa non va?
#8,898 0 commenti 1 reazione 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Una pull request collegata è già stata integrata.

  • #1 di @thekarthikh — chiusa senza merge
  • #8899 di @thswlsqls — integrata
  • #8901 di @thekarthikh — chiusa senza merge

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
94/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
java
Ambito
documentation

Direzione di ricerca

Inizia in sdk-extensions/autoconfigure-spi, in ConfigProperties.java, e rivedi il Javadoc dei tre metodi indicati. Confronta il comportamento documentato con DefaultConfigProperties.getDuration e con le asserzioni in ConfigPropertiesTest. Il lavoro è completato quando il Javadoc descrive accuratamente gli errori, le unità supportate e i valori restituiti senza modificare il comportamento o le firme.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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 returns null if the property "has a wrong type". Its own @throws says malformed values throw, and DefaultConfigProperties.getDuration throws ConfigurationException for a bad number or unit (asserted in ConfigPropertiesTest). A custom implementation that follows the first sentence would silently fall back to defaults.
  • The getDuration(String) unit list omits ns and us, which DefaultConfigProperties accepts.
  • The @return of getDuration(String, Duration) and getMap(String, Map) says "a Double-valued configuration property", copied from getDouble(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
Lingua principale
Java
Stelle
2.5k
Fork
1k
Merge medio
2g 20h
PR unite (30g)
62

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di open-telemetry/opentelemetry-java

Tutte le issue di open-telemetry/opentelemetry-java

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.