Skip to content

Fix stale parameter name in JcTools.drain Javadoc#8513

Draft
thswlsqls wants to merge 1 commit into
open-telemetry:mainfrom
thswlsqls:docs/fix-jctools-drain-throws-param
Draft

Fix stale parameter name in JcTools.drain Javadoc#8513
thswlsqls wants to merge 1 commit into
open-telemetry:mainfrom
thswlsqls:docs/fix-jctools-drain-throws-param

Conversation

@thswlsqls

Copy link
Copy Markdown
Contributor

Description

  • JcTools.drain(Queue, int, Consumer) documents @throws IllegalArgumentException if maxExportBatchSize is negative, but no maxExportBatchSize parameter exists; the argument is limit.
  • The name is a leftover from the private drainNonJcQueue(..., int maxExportBatchSize, ...) helper removed in Proactively avoid Unsafe on Java 23+ #7691. The thrown behavior is unchanged: the delegate MessagePassingQueue.drain(Consumer, int) throws IllegalArgumentException for a negative limit.
  • Javadoc-only change in the internal, non-published :sdk:trace-shaded-deps module; no signature, behavior, or public API change.

Testing done

  • Docs-only, test-exempt: no test added; ./gradlew :sdk:trace-shaded-deps:check passed.

The @throws clause referenced maxExportBatchSize, a parameter that does
not exist on drain(Queue, int, Consumer). It was left over from the
private drainNonJcQueue helper removed in open-telemetry#7691. Point it at the actual
parameter, limit.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@linux-foundation-easycla

Copy link
Copy Markdown

CLA Missing ID

  • ✅ login: thswlsqls / name: Eunbin Son (8ecffaf)
  • ❌ The email address for the commit (8ecffaf) is not linked to the GitHub account, preventing the EasyCLA check. Consult this Help Article and GitHub Help to resolve. (To view the commit's email address, add .patch at the end of this PR page's URL.) For further assistance with EasyCLA, please visit our EasyCLA portal and chat with our support bot.

One or more co-authors of this pull request were not found. You must specify co-authors in commit message trailer via:

Co-authored-by: name <email>

Supported Co-authored-by: formats include:

  1. Anything <id+login@users.noreply.github.com> - it will locate your GitHub user by id part.
  2. Anything <login@users.noreply.github.com> - it will locate your GitHub user by login part.
  3. Anything <public-email> - it will locate your GitHub user by public-email part. Note that this email must be made public on Github.
  4. Anything <other-email> - it will locate your GitHub user by other-email part but only if that email was used before for any other CLA as a main commit author.
  5. login <any-valid-email> - it will locate your GitHub user by login part, note that login part must be at least 3 characters long.

Alternatively, if the co-author should not be included, remove the Co-authored-by: line from the commit message.

Please update your commit message(s) by doing git commit --amend and then git push [--force] and then request re-running CLA check via commenting on this pull request:

/easycla

@codecov

codecov Bot commented Jun 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.77%. Comparing base (824334c) to head (8ecffaf).

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #8513   +/-   ##
=========================================
  Coverage     78.77%   78.77%           
  Complexity     8579     8579           
=========================================
  Files          1009     1009           
  Lines         28993    28993           
  Branches       3599     3599           
=========================================
  Hits          22839    22839           
  Misses         5311     5311           
  Partials        843      843           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant