Thanks for the update. Do you think the comment below would look a bit better? 
Basically I am trying to make the language style look more formatted and 
consistent. And the explanation for `LogCleaningPaused(i)` can probably be 
simplified.


```
/**
  * This class manages the state of each partition being cleaned.
  * LogCleaningState defines the cleaning states that a TopicPartition can be 
in.
  * 1. None                    : No cleaning state in a TopicPartition. In this 
state, it can become LogCleaningInProgress or LogCleaningPaused(1).
  *                              Valid previous state is LogCleaningInProgress 
or LogCleaningPaused(1).
  * 2. LogCleaningInProgress   : The cleaning is currently in progress. In this 
state, it can become None when log cleaning is finished
  *                              or become LogCleaningAborted. Valid previous 
state is None.
  * 3. LogCleaningAborted      : The cleaning abort is requested. In this 
state, it can become LogCleaningPaused(1).
  *                              Valid previous state is LogCleaningInProgress.
  * 4. LogCleaningPaused(1)    : The cleaning is paused once. No log cleaning 
can be done in this state.
  *                              In this state, it can become None or 
LogCleaningPaused(2).
  *                              Valid previous state is None, 
LogCleaningAborted or LogCleaningPaused(2).
  * 4. LogCleaningPaused(i)    : The cleaning is paused i times where i >= 2. 
No log cleaning can be done in this state.
  *                              In this state, it can become 
LogCleaningPaused(i-1) or LogCleaningPaused(i+1)
  *                              Valid previous state is LogCleaningPaused(i-1) 
or LogCleaningPaused(i+1).
  */
```

[ Full content available at: https://github.com/apache/kafka/pull/5694 ]
This message was relayed via gitbox.apache.org for [email protected]

Reply via email to