[GitHub] storm pull request: [STORM-1015] Allow Kafka offsets to be saved u...

[rmkellogg <gi...@git.apache.org>]

Github user rmkellogg commented on the pull request:

    https://github.com/apache/storm/pull/705#issuecomment-138665642
  
    A few minor nits:
    
    When providing javadoc on variables/methods, be sure to use the following syntax:
     /**
      * Comment text
      **/
    private String variableName;
    
    Instead of the following:
    
    // offset state information storage. validate options are storm and kafka  
    private String variableName;
    
    The first variation will provide fly-over-help within IDE and generated Javadoc files.
    
    Secondly:
    
    Logger instance variables should be private.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---