Ticket #8612 (closed: fixed)
Clarification of a section of the Plus algorithm documentation
Reported by: | Russell Taylor | Owned by: | Russell Taylor |
---|---|---|---|
Priority: | trivial | Milestone: | Release 3.1 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | Tester: | Wenduo Zhou |
Description
A user said:
"I have ben using Plus to concatenate runs for a while. I just happened to look at the wiki pages and saw that it seems like it might end up merging different detectors together is this true?"
They were referring to the text:
"Event lists at each workspace index are concatenated to create the output event list at the same workspace index. Note that in some cases, these event lists might be from different detectors; this is not checked against and the event lists will be concatenated anyway."
In fact they were fine to use Plus and this text should be updated to avoid alarming people by making clear the (rare) circumstances where this might be the case, and clarify that if the operands have been processed in the same way then this should never be the case.
Change History
comment:2 Changed 7 years ago by Russell Taylor
- Status changed from inprogress to verify
- Resolution set to fixed
Very easy to test - just look at the diff in code and wiki. Branch is feature/8612_plus_docs_clarification
comment:3 Changed 7 years ago by Wenduo Zhou
- Status changed from verify to verifying
- Tester set to Wenduo Zhou
comment:4 Changed 7 years ago by Wenduo Zhou
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/8612_plus_docs_clarification'
Full changeset: 087ebc542a877acac29eebf430165e31aaa05828
Re #8612. Small addition to the wiki docs.
This is just to clarify when you might need to use MergeRuns instead of Plus (and more pertinently to make it clear that usually Plus is fine).
Changeset: 5d35bb2c35380238914aa039c18acea460e39379