Fix documentation terminology and method usage#4617
Merged
Conversation
added 4 commits
June 11, 2025 20:09
### Motivation The current documentation incorrectly uses "Enumerator" when referring to the Java standard interface `java.util.Enumeration`. "Enumerator" is not a valid Java term, leading to confusion and inaccuracies. **Impact** 1. Misleads developers searching for non-existent `Enumerator` APIs 2. Creates inconsistency with Java official documentation 3. May cause misunderstandings about legacy Java collection frameworks ### Modification - Replaced all `Enumerator` references with `Enumeration`
…ration"" This reverts commit dc84399
### Motivation The current documentation incorrectly uses "Enumerator" when referring to the Java standard interface `java.util.Enumeration`. "Enumerator" is not a valid Java term, leading to confusion and inaccuracies. **Impact** 1. Misleads developers searching for non-existent `Enumerator` APIs 2. Creates inconsistency with Java official documentation 3. May cause misunderstandings about legacy Java collection frameworks ### Modification - Replaced all `Enumerator` references with `Enumeration`
liangyepianzhou
force-pushed
the
doc/Enumerator
branch
from
e1f9dbc to
44ecdef
Compare
liangyepianzhou
changed the title
StevenLuMT
requested review from
Copilot,
dlg99,
eolivelli,
hezhangjian and
zymap
There was a problem hiding this comment.
Pull Request Overview
This PR fixes terminology and API usage in the ledger API documentation to align with Java standards and prevent compilation errors.
- Replaces incorrect
Enumeratorreferences withjava.util.Enumeration - Updates loop and entry methods:
hasNextElement()→hasMoreElements(),getId()→getEntryId() - Adds missing
@Overrideannotation and corrects thedeleteCompletecallback signature
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
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.
Motivation
java.util.EnumerationhasNextElement()instead ofhasMoreElements(),entry.getId()instead ofentry.getEntryId())Impact
EnumeratorAPIsChanges
Replaced all
Enumeratorreferences withEnumerationhasNextElement()→hasMoreElements()in loop conditionsentry.getId()→entry.getEntryId()for entry ID access@Overrideannotation in async callback