hyperledger / fabric-x-committer / 30786649713

91%

Build Type

push

github

Committed by web-flow

Commit Message

[utils] Correct the comments on writing to an optional channel output (#726)

#### Type of change

- Documentation update

#### Description

- `deliver` and `deliverorderer` treat a nil output channel as an output
the caller does not want.
The comments claimed the write "will be no-op if the output buffer is
nil", which is wrong
twice over: a send on a nil channel blocks forever rather than doing
nothing, and
`channel.Write` in fact reports such a write as failed. Both call sites
ignore the result, so the
  behavior was always correct — only the comments were not.
- Document the same contract on `channel.NewWriter`, where it belongs,
so it is not re-derived at
  each call site.

#### Related issues

- resolves #722

Signed-off-by: Liran Funaro <liran.funaro@gmail.com>

Coverage Stats

4 of 4 new or added lines in 2 files covered. (100.0%)

16 existing lines in 6 files now uncovered.

10539 of 11549 relevant lines covered (91.25%)

33219.37 hits per line