Skip to content

docs(harness): reattach toFilesystem javadoc in LocalFilesystemSpec - #3432

Open
zh-hanlabs wants to merge 1 commit into
agentscope-ai:mainfrom
zh-hanlabs:docs/reattach-filesystem-spec-javadoc
Open

zh-hanlabs wants to merge 1 commit into
agentscope-ai:mainfrom
zh-hanlabs:docs/reattach-filesystem-spec-javadoc

Conversation

@zh-hanlabs

Copy link
Copy Markdown

AgentScope-Java Version

2.0.4-SNAPSHOT (current main)

Description

The javadoc for LocalFilesystemSpec.toFilesystem(Path, NamespaceFactory) was orphaned: it sat directly above getProject(), so:

  • toFilesystem — the method it actually documents — had no javadoc, even though its @param workspace / @param localNamespaceFactory tags match that method's exact signature (and the body references {@link #project(Path)}, a member of this spec);
  • getProject() was preceded by two stacked javadoc blocks.

This PR moves the block verbatim down to toFilesystem. Comment-only change: no wording, formatting, or behavior changes.

How to test: comment-only move — no code paths touched; wording and indentation preserved, so mvn spotless:check output is unaffected. The full test suite was not re-run since no executable code changed.

Checklist

Please check the following items before code is ready to be reviewed.

  • Code has been formatted with mvn spotless:apply (comment-only move; formatting unchanged)
  • All tests are passing (mvn test) — not re-run; comment-only change, no code paths touched
  • Javadoc comments are complete and follow project conventions

Copilot AI balanced review requested due to automatic review settings October 7, 2026 14:04

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@jujn

jujn commented Oct 7, 2026

Copy link
Copy Markdown
Collaborator

请签署 CLA

@codecov

codecov Bot commented Oct 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

This branch has not been deployed

No deployments
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.

4 participants