zookeeper-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [zookeeper] BELUGABEHR commented on a change in pull request #878: ZOOKEEPER-3339: Improve Debug and Trace Log Statements
Date Fri, 26 Apr 2019 14:46:08 GMT
BELUGABEHR commented on a change in pull request #878: ZOOKEEPER-3339: Improve Debug and Trace
Log Statements
URL: https://github.com/apache/zookeeper/pull/878#discussion_r278980717
 
 

 ##########
 File path: zookeeper-server/src/main/java/org/apache/zookeeper/server/quorum/FastLeaderElection.java
 ##########
 @@ -838,11 +839,11 @@ synchronized public Vote getVote(){
      */
     private ServerState learningState(){
         if(self.getLearnerType() == LearnerType.PARTICIPANT){
-            LOG.debug("I'm a participant: " + self.getId());
+            LOG.debug("I am a participant: {}", self.getId());
 
 Review comment:
   This is called a 'contraction'.  A contraction is a shortened version of the written and
spoken forms of a word, syllable, or word group, created by omission of internal letters and
sounds.
   
   There is no hard-and-fast rule, but I generally encourage folks to avoid them, especially
when using them in application output of any kind.
   
   `Only use them in "conversational" parts of the documentation (i.e. explanatory text).`
   
   https://docs.ubuntu.com/styleguide/en#contractions
   https://developers.google.com/style/contractions

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message