keith-turner commented on issue #747: Shorten method names in AccumuloClient 
builder
URL: https://github.com/apache/accumulo/issues/747#issuecomment-436290422
 
 
   One reason to not use `from(String)` now is that we may want to leave it 
available for future use.  I have always though it would be nice if Accumulo 
had a standardized connection string that could encode instance, zookeepers, 
and credentials.  It may be nice to have `from(String connectionString)` in the 
future. 
   
   > Some boilerplate is reasonable, when it helps clearly communicate the 
required type
   
   I realized that for communication, the variable name used in the API is much 
more important than the type.  If I see `from(Path foo)` I would still need to 
consult javadoc.  However if I see `from(Path clientPropsFile)` or `from(String 
clientPropsFile)` then I may not need javadoc.  
   
   > Maybe "useJsse" makes more sense than just "jsse".
   
   We need to strike that balance between adding useless noise and useful 
information. I think this ends up being a function of the number of unique 
prefixes and the number of methods similar to TFIDF. Also, we may be ok making 
the less frequently used methods longer and therefore more self documenting. 
For this case `enable` may be a better prefix for communicating useful info.   
I am really happy to see this proposal shorten the most frequently used 
methods.  
   
   Seems like the following could lead to boilerplate code because every user 
has to split/parse this.  The zookeeper API just takes String for this.
   
   ```java
   to(CharSequence name, CharSequence[] zookeepers);
   ```
   
   
   
   
   
   
   
   
   
   
   

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


With regards,
Apache Git Services

Reply via email to