Purpose and Motivation

b4b70b4 introduces a copy/paste error into the documentation for pvcollect.

The function for this method should take the magnitude and phase for a single bin, and return either a new magnitude or a magnitude/phase pair for this bin only.

The revision adds an "example function" that takes | magnitude, phase, bin, index | as arguments but then returns [mags.reverse, phases.reverse]. mags and phases are undeclared, so this will never work. Also, it's conceptually inconsistent. pvcollect operate on individual bins, not on all of them at once: reverse doesn't make sense in this context. But it does make sense for pvcalc.

The PR replaces the return with a simple per-bin randomizer.

Types of changes

• Documentation

Checklist

• [n/a] All tests are passing
• [n/a] If necessary, new tests were created to address changes in PR, and tests are passing
• Updated documentation, if necessary
• This PR is ready for review

(It's a correction for a typo. The checklist is basically superfluous.)