thswlsqls opened a new pull request, #39850:
URL: https://github.com/apache/shardingsphere/pull/39850
No issue: typo fix.
Changes proposed in this pull request:
- Correct the class Javadoc of `ShadowAlgorithmSegment` from "Shadow
algorithms segment." to the singular. The class holds exactly one algorithm
(`algorithmName` and a single `AlgorithmSegment`); the collection lives in
`ShadowRuleSegment.shadowTableRules`, and
`ShadowDistSQLStatementVisitor.visitAlgorithmDefinition()` builds one segment
per algorithm definition.
- Remove "rule" from the class Javadoc of
`AlterDefaultShadowAlgorithmStatement` and
`CreateDefaultShadowAlgorithmStatement`. `RDLStatement.g4` defines them as
`CREATE|ALTER DEFAULT SHADOW ALGORITHM` with no `RULE` keyword, so the
summaries named a keyword that does not exist in the grammar. The siblings
`DropDefaultShadowAlgorithmStatement` and
`ShowDefaultShadowAlgorithmStatement`, `CreateDefaultShadowAlgorithmExecutor`,
and the English documentation already omit it.
- Extending `AlterRuleStatement` / `CreateRuleStatement` does not call for
"rule" in the summary: `AlterDefaultShardingStrategyStatement` and
`CreateDefaultShardingStrategyStatement` extend the same base types and read
"Alter/Create default sharding strategy statement."
- Javadoc text only: no behaviour, signature, or bytecode change, so no
unit tests or Release Notes entry.
AI assistance: Claude Code was used to locate and draft these Javadoc
corrections in `features/shadow/distsql/statement`. I reviewed and verified
every line submitted.
---
Before committing this PR, I'm sure that I have checked the following
options:
- [x] My code follows the [code of
conduct](https://shardingsphere.apache.org/community/en/involved/conduct/code/)
of this project.
- [x] I have self-reviewed the commit code.
- [ ] I have (or in comment I request) added corresponding labels for the
pull request.
- [x] I have passed maven check locally : `./mvnw clean install -B -T1C
-Dmaven.javadoc.skip -Dmaven.jacoco.skip -e`.
- [ ] I have made corresponding changes to the documentation.
- [ ] I have added corresponding unit tests for my changes.
- [ ] I have updated the Release Notes of the current development version.
For more details, see [Update Release
Note](https://shardingsphere.apache.org/community/en/involved/contribute/contributor/)
- [x] I have disclosed the tool and affected files or scope for any material
AI assistance, as required by the [AI-assisted contribution policy].
[AI-assisted contribution policy]:
https://github.com/apache/shardingsphere/blob/master/AI_POLICY.md
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
