ACCUMULO-4170 Clarify ClientConfiguration javadocs #307
Conversation
Updated the javadoc information with the ClientConfiguration class. Specifically reworked the default search path information to be displayed as a list rather than inline, thereby easing readability. Reworded a few of the sentences and moved the path order up to the class level rather than the method level.
|
Is this the same change as #306? We usually make the change in the oldest branch and then merge it forward. |
|
The change for 1.8 is slightly different than for 1.7. Although the 1.8 and 2.0 changes are identical so the #307 could be merged forward. I wasn't sure how that situation was handled so I ended up creating a pull request for master as well. |
Reverted default search path information back to method level versus class level.
There was a problem hiding this comment.
Changes look good to me. Thanks for taking a look and fixing the docs. Looking at this, though, I'm realizing that our current mechanism for handling client-side configuration is pretty awful. I'm wondering what we can do about that. I think in future, maybe we should consider less "magical" behavior, and more APIs which require explicit input from the caller to create the configuration the caller requires.
Re-introduced some documentation to the loadDefaults() methods that had inadvertently been overlooked in a previos commit.
ACCUMULO-4170 Clarify ClientConfiguration javadocs
Updated the javadoc information with the ClientConfiguration class.
Specifically reworked the default search path information to be
displayed as a list rather than inline, thereby easing readability.
Reworded a few of the sentences and moved the path order up to the class
level rather than the method level.