Skip to content

docs: attach orphaned javadoc to resolveToolInstance in ComponentRegistry - #1625

Merged
copybara-service[bot] merged 1 commit into
google:mainfrom
zh-hanlabs:docs/component-registry-orphan-javadoc
Oct 15, 2026
Merged

copybara-service[bot] merged 1 commit into
google:mainfrom
zh-hanlabs:docs/component-registry-orphan-javadoc

Conversation

@zh-hanlabs

@zh-hanlabs zh-hanlabs commented Oct 7, 2026 •

Copy link
Copy Markdown

Please ensure you have read the contribution guide before creating a pull request.

Link to Issue or Description of Change

2. Or, if no issue exists, describe the change:

Problem:
The javadoc describing resolveToolInstance ("Resolves the tool instance based on the tool name from the configuration") is orphaned: it sits directly above the resolveToolsetInstance javadoc block, leaving resolveToolInstance(String) undocumented.

Solution:
Move the orphaned javadoc block down so it is attached to resolveToolInstance. Comment-only move; no wording or code changes.

Testing Plan

Small documentation-only fix (no tests required per the template guidance). Verified the @param name / @return text matches the method signature; no behavioral change.

Unit Tests:

  • I have added or updated unit tests for my change. (N/A: documentation-only fix)
  • All unit tests pass locally. (no code paths touched)

Manual End-to-End (E2E) Tests:

N/A — comment-only change.

Checklist

  • I have read the CONTRIBUTING.md document.
  • My pull request contains a single commit.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas. (N/A: this change only moves an existing comment)
  • I have added tests that prove my fix is effective or that my feature works. (N/A: documentation-only fix)
  • New and existing unit tests pass locally with my changes. (N/A: documentation-only fix)
  • I have manually tested my changes end-to-end. (N/A: documentation-only fix)
  • Any dependent changes have been merged and published in downstream modules. (N/A)

Additional context

Contributor CLA is signed / being signed so the CLA check can pass.

@google-cla

google-cla Bot commented Oct 7, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@hemasekhar-p hemasekhar-p self-assigned this Oct 8, 2026
@hemasekhar-p

Copy link
Copy Markdown
Contributor

Hi @zh-hanlabs, thank you for your contribution and We appreciate you taking the time to submit this pull request. Since this is your first contribution, could you please complete the Google CLA so we can proceed with the review process?

@hemasekhar-p hemasekhar-p added the waiting on reporter Waiting for reaction by reporter. Failing that, maintainers will eventually closed it as stale. label Oct 8, 2026
@zh-hanlabs
zh-hanlabs force-pushed the docs/component-registry-orphan-javadoc branch from d4ad0ff to 6592e8b Compare October 8, 2026 13:14
@zh-hanlabs

Copy link
Copy Markdown
Author

Hi @hemasekhar-p, thanks! I've signed the CLA and the cla/google check now passes. Could you please take a look when you have a chance?

@hemasekhar-p
hemasekhar-p force-pushed the docs/component-registry-orphan-javadoc branch from 6592e8b to 09a1496 Compare October 8, 2026 13:24
@hemasekhar-p

Copy link
Copy Markdown
Contributor

@zh-hanlabs, thanks for quick update and Our team is currently reviewing your changes and we will reach out if we need any further information. Thank you.

@hemasekhar-p hemasekhar-p added needs review and removed waiting on reporter Waiting for reaction by reporter. Failing that, maintainers will eventually closed it as stale. labels Oct 8, 2026
@copybara-service
copybara-service Bot merged commit 2ab4d32 into google:main Oct 15, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants