You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by "terrymanu (via GitHub)" <gi...@apache.org> on 2026/07/20 09:39:03 UTC
[PR] Improve Javadoc guidance and remove redundant MCP prose [shardingsphere]
terrymanu opened a new pull request, #39191:
URL: https://github.com/apache/shardingsphere/pull/39191
- distinguish required Javadoc structure from actionable contract details
- remove repeated collection, inheritance, and annotation descriptions
- preserve concurrency, ownership, and protocol error semantics
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve Javadoc guidance and remove redundant MCP prose [shardingsphere]
Posted by "terrymanu (via GitHub)" <gi...@apache.org>.
terrymanu merged PR #39191:
URL: https://github.com/apache/shardingsphere/pull/39191
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve Javadoc guidance and remove redundant MCP prose [shardingsphere]
Posted by "terrymanu (via GitHub)" <gi...@apache.org>.
terrymanu commented on PR #39191:
URL: https://github.com/apache/shardingsphere/pull/39191#issuecomment-5020858013
### Summary
**Review Result: Mergeable**
Reason: The PR correctly addresses its stated documentation-quality goal by adding a durable Javadoc signal-to-noise rule and removing redundant MCP prose. The result is code-scope only; CI not reviewed by request.
### Evidence
- The latest head is `92b1ad60714c2da592cccbfcb08f8dd1f885a388`, with six changed files matching the GitHub PR file list: [PR #39191](https://github.com/apache/shardingsphere/pull/39191).
- [AGENTS.md:87](https://github.com/apache/shardingsphere/blob/92b1ad60714c2da592cccbfcb08f8dd1f885a388/AGENTS.md#L87) distinguishes required Javadoc structure from optional contract prose without weakening the repository requirement for public API/SPI documentation.
- The MCP changes remove only redundant or duplicated explanations:
- [MCPHandlerProvider.java:28](https://github.com/apache/shardingsphere/blob/92b1ad60714c2da592cccbfcb08f8dd1f885a388/mcp/api/src/main/java/org/apache/shardingsphere/mcp/spi/MCPHandlerProvider.java#L28) removes annotation and generic collection repetition while retaining concurrency/lifecycle semantics.
- [MCPRequestContext.java:30](https://github.com/apache/shardingsphere/blob/92b1ad60714c2da592cccbfcb08f8dd1f885a388/mcp/api/src/main/java/org/apache/shardingsphere/mcp/api/MCPRequestContext.java#L30) removes detail already documented by `MCPSessionIdentity`.
- [MCPFeatureRequestContext.java:30](https://github.com/apache/shardingsphere/blob/92b1ad60714c2da592cccbfcb08f8dd1f885a388/mcp/support/src/main/java/org/apache/shardingsphere/mcp/support/MCPFeatureRequestContext.java#L30) removes the parent-interface lifecycle duplicate.
- [MCPSuccessPayload.java:24](https://github.com/apache/shardingsphere/blob/92b1ad60714c2da592cccbfcb08f8dd1f885a388/mcp/api/src/main/java/org/apache/shardingsphere/mcp/api/payload/MCPSuccessPayload.java#L24) and [MCPMapPayload.java:25](https://github.com/apache/shardingsphere/blob/92b1ad60714c2da592cccbfcb08f8dd1f885a388/mcp/support/src/main/java/org/apache/shardingsphere/mcp/support/protocol/payload/MCPMapPayload.java#L25) retain the relevant protocol, failure, and ownership contracts in shorter form.
- No production behavior, API signature, SPI contract, dependency, or runtime path was changed. No additional test is required for documentation-only changes.
### Review Details
- Review Focus: Code Correctness Review; CI not reviewed by request.
- Reviewed Scope: `AGENTS.md` and the five MCP Java files changed by the PR; local three-dot scope matched GitHub’s six-file list.
- Not Reviewed Scope: GitHub Actions, check-runs, runtime/E2E execution, and unrelated repository files.
- Verification:
- `./mvnw -pl mcp/api,mcp/support,test/e2e/mcp spotless:apply -Pcheck -T1C` — exit 0.
- `./mvnw -pl mcp/api,mcp/support,test/e2e/mcp checkstyle:check -Pcheck -T1C` — exit 0; 0 Checkstyle violations.
- Release Note / User Docs: Not required; this is an internal agent-guidance and Javadoc cleanup change.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org