flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FLINK-5597) Improve the LocalClusteringCoefficient documentation
Date Sun, 26 Feb 2017 17:21:46 GMT

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

ASF GitHub Bot commented on FLINK-5597:
---------------------------------------

Github user uce commented on the issue:

    https://github.com/apache/flink/pull/3404
  
    Changes read well. +1 to merge.
    
    Small note on JavaDocs and usage of `<br>` tags: I think the common way is to use
`<p>` when the paragraph starts.
    
    ```java
    /**
     * Hyperlink-Induced Topic Search computes two interdependent scores for every
     * vertex in a directed graph. A good "hub" links to good "authorities" and
     * good "authorities" are linked from good "hubs".
     * 
     * <p>This algorithm can be configured to terminate either by a limit on the number
     * of iterations, a convergence threshold, or both.
     * 
     * <p>http://www.cs.cornell.edu/home/kleinber/auth.pdf
     *
     * @param <K> graph ID type
     * @param <VV> vertex value type
     * @param <EV> edge value type
     */
    public class HITS<K, VV, EV> {}
    ```
    
    Of course, we don't have a code style ;-). Just wanted to mention it, I don't think that
this needs changes with this PR.


> Improve the LocalClusteringCoefficient documentation
> ----------------------------------------------------
>
>                 Key: FLINK-5597
>                 URL: https://issues.apache.org/jira/browse/FLINK-5597
>             Project: Flink
>          Issue Type: Improvement
>          Components: Documentation, Gelly
>    Affects Versions: 1.3.0
>            Reporter: Vasia Kalavri
>            Assignee: Greg Hogan
>             Fix For: 1.3.0
>
>
> The LocalClusteringCoefficient usage section should explain what is the algorithm output
and how to retrieve the actual local clustering coefficient scores from it.



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

Mime
View raw message