Repository navigation
Fix comment typos and error message inconsistencies - #515
Closed
Tino Chan (tinochan) wants to merge 1 commit into
Closed
Tino Chan (tinochan) wants to merge 1 commit into
Tino Chan (tinochan) wants to merge 1 commit into
Conversation
Category A - Javadoc/comment typos: - Disruptor: fix "threads to for processors" javadoc - RewindAction: fix "from he beginning" typo - PhasedBackoffWaitStrategy: fix "time in to" javadoc typos - Sequencer: fix "initialise too" -> "initialise to" - ExceptionHandlerWrapper: remove stray space in method call Category B - error message inconsistencies (guard semantics unchanged): - RingBuffer: "must be positive" -> "must not be negative" - SingleProducerSequencer/MultiProducerSequencer: "n must be > 0 and <= bufferSize"
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.
Summary
Fix minor documentation and error message issues across the codebase so the messages match the actual validation logic.
Javadoc/comment typos: corrected misspelled and malformed wording in
Disruptor,RewindAction,PhasedBackoffWaitStrategy,Sequencer, andExceptionHandlerWrapper.Error message inconsistencies: exception messages did not match the actual guard conditions they describe.
Changes
Javadoc/comment typos
Disruptor.java: "to create threads to for processors" -> "to create threads for processors"RewindAction.java: "from he beginning" -> "from the beginning"PhasedBackoffWaitStrategy.java: "time in to busy spin/yield for" -> "time to busy spin/yield for" (6 occurrences)Sequencer.java: "The sequence to initialise too." -> "The sequence to initialise to."ExceptionHandlerWrapper.java: removed stray space ingetExceptionHandler().handleOnShutdownExceptionError message inconsistencies (guard semantics unchanged)
RingBuffer.java: "must be positive" -> "must not be negative" (the guard rejects only negative values; 0 is valid)SingleProducerSequencer.java: "n must be > 0 and < bufferSize" -> "n must be > 0 and <= bufferSize" (n == bufferSize is allowed)MultiProducerSequencer.java: same message fix as aboveTesting
./gradlew test