[
https://issues.apache.org/jira/browse/CURATOR-124?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14070553#comment-14070553
]
ASF GitHub Bot commented on CURATOR-124:
----------------------------------------
GitHub user pperalta opened a pull request:
https://github.com/apache/curator/pull/19
CURATOR-124 - PathChildrenCache StartMode documentation improvement
Updated `PathChildrenCache.StartMode.NORMAL` JavaDoc to accurately depict
the cache startup behavior.
Added test `testChildrenInitializedNormal` to assert the startup behavior
indicated in the JavaDoc.
My IDE is also configured to remove trailing white space by default. If
this is a problem I can remove those changes and resubmit.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/pperalta/curator CURATOR-124
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/curator/pull/19.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #19
----
commit e2eed55985b1d5efbc74ca04afcdac28c8400fe6
Author: Patrick Peralta <[email protected]>
Date: 2014-07-22T17:23:43Z
CURATOR-124 - PathChildrenCache StartMode doc
Updated PathChildrenCache.StartMode.NORMAL JavaDoc to
accurately depict the cache startup behavior.
Added test testChildrenInitializedNormal to assert
the startup behavior indicated in the JavaDoc.
----
> PathChildrenCache StartMode documentation improvement
> -----------------------------------------------------
>
> Key: CURATOR-124
> URL: https://issues.apache.org/jira/browse/CURATOR-124
> Project: Apache Curator
> Issue Type: Improvement
> Components: Recipes
> Reporter: Patrick Peralta
> Priority: Minor
> Original Estimate: 2h
> Remaining Estimate: 2h
>
> When using {{PathChildrenCache}}, the documented behavior for
> {{StartMode.NORMAL}} is as follows:
> {panel}
> cache will _not_ be primed. i.e. it will start empty and you will receive
> events for all nodes added, etc.
> {panel}
> However my observation is that the cache is primed. This was confirmed by
> Jordan in an email thread on the mailing list on June 23 2014:
> {panel}
> Yes, POST_INITIALIZED_EVENT is the same as NORMAL except you get the
> INITIALIZED event. You can see this in
> TestPathChildrenCache.testChildrenInitialized(). Please send a PR with doc
> updates if you think they can be improved.
> {panel}
> When I looked into {{TestPathChildrenCache.testChildrenInitialized()}}, it
> appears to be testing the {{POST_INITIALIZED_EVENT}} behavior. I will add a
> new test {{testChildrenInitializedNormal}} to assert the cache initialization
> behavior describe above for mode {{NORMAL}}. Furthermore I will modify the
> doc to indicate this behavior.
> This issue will be updated with a link to the PR when it is ready.
--
This message was sent by Atlassian JIRA
(v6.2#6252)
