[ 
https://issues.apache.org/jira/browse/KAFKA-4800?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15889997#comment-15889997
 ] 

ASF GitHub Bot commented on KAFKA-4800:
---------------------------------------

GitHub user cvaliente opened a pull request:

    https://github.com/apache/kafka/pull/2621

    KAFKA-4800: Streams State transition ASCII diagrams need fixing and 
polishing

    added <pre> tags to not break javadoc display of the ASCII diagrams.
    see broken ascii here:
    
https://kafka.apache.org/0102/javadoc/org/apache/kafka/streams/KafkaStreams.State.html
    
    fix can be checked with gradle :streams:javadoc and then checking 
streams/build/docs/javadoc/org/apache/kafka/streams/KafkaStreams.State.html
    
    I also fixed the diagram in StreamThread.java however currently no javadoc 
is generated for that one (since it's internal)
    
    @enothereska please have a look

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/cvaliente/kafka KAFKA-4800-ASCII-diagrams

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/kafka/pull/2621.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #2621
    
----
commit 88e83d4633b782f8554f5d3b871e703c0a580657
Author: Clemens Valiente <clemens.valie...@trivago.com>
Date:   2017-03-01T10:47:21Z

    KAFKA-4800 fix display and transitions of ASCII diagrams

----


> Streams State transition ASCII diagrams need fixing and polishing
> -----------------------------------------------------------------
>
>                 Key: KAFKA-4800
>                 URL: https://issues.apache.org/jira/browse/KAFKA-4800
>             Project: Kafka
>          Issue Type: Bug
>          Components: streams
>    Affects Versions: 0.10.2.0
>            Reporter: Eno Thereska
>            Assignee: Clemens Valiente
>            Priority: Minor
>              Labels: newbie
>             Fix For: 0.10.3.0
>
>
> The ASCII transition diagram in KafkaStreams.java on top of "public enum 
> State" does not read well in Javadoc. Also the self-loops to running and 
> rebalancing are not necessary. Same with the StreamThread.java diagram.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

Reply via email to