docs: fix README event count and Model javadoc to match code - #2497
Open
helloworldtang wants to merge 3 commits into
Open
docs: fix README event count and Model javadoc to match code#2497helloworldtang wants to merge 3 commits into
helloworldtang wants to merge 3 commits into
Conversation
AgentEventType defines 31 enum values (and AgentEvent registers 31 @JsonSubTypes.Type), but README/README_zh still advertise 28. Update both locales to match the actual event count.
Model#getContextWindowSize() javadoc referenced 'the compaction middleware' as if it were a core component, but CompactionMiddleware resides in agentscope-harness. Qualify the reference so core readers are not misled.
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
|
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & Why
Found two documentation/code inconsistencies while reviewing the 2.0 GA codebase. This PR fixes both — docs only, no behavior change.
1. Typed event count is 31, not 28
AgentEventTypedefines 31 enum values andAgentEventregisters 31@JsonSubTypes.Type, butREADME.md(×2) andREADME_zh.mdstill advertise "28 typed events". None of the 31 events are deprecated, so 28 is simply stale.Updated all three occurrences (README.md ×2, README_zh.md ×1) to 31.
2.
Model#getContextWindowSize()javadoc points at a non-core componentThe javadoc on
Model#getContextWindowSize()says "Used by the compaction middleware to ...", butCompactionMiddlewarelives in agentscope-harness, notagentscope-core. The claim is accurate (the harnessCompactionMiddlewaredoes callmodel.getContextWindowSize()atCompactionMiddleware.java:157), but "the compaction middleware" reads as a core concept and misleads readers exploring core in isolation. Qualified it to "the harness-layer compaction middleware".Verification
mvn -pl agentscope-core spotless:check✅ passesChecklist
docs(scope): subject)