Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

ConfigProperties Javadoc does not match getDuration and getMap behavior

クローズ 初心者向け
  • 何か問題がありますか？
#8,898 コメント 0 件 リアクション 1 件 担当者 0 名 GitHub で見る

メンテナーはふだん 2 日以内に返信

関連するプルリクエストがすでにマージされています。

  • #1 @thekarthikh による — マージされずにクローズ
  • #8899 @thswlsqls による — マージ済み
  • #8901 @thekarthikh による — マージされずにクローズ

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
94/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
java
領域
documentation

調査の方向性

sdk-extensions/autoconfigure-spi の ConfigProperties.java から始め、名前が示されている 3 つのメソッドの Javadoc を確認してください。ドキュメントに記載された動作を DefaultConfigProperties.getDuration および ConfigPropertiesTest のアサーションと比較してください。動作やシグネチャを変更せずに、Javadoc がエラー、サポートされている単位、戻り値を正確に説明していれば完了です。

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

説明

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
主要言語
Java
スター
2.5k
フォーク
1k
平均マージ
2日 22時間
マージ済み PR（30日）
59

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

open-telemetry/opentelemetry-java のほかの issue

open-telemetry/opentelemetry-java の issue をすべて見る

似ている issue

Java の issue をもっと見る

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

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