hyperledger / fabric-x-committer / 30748296571

91%

main: 91%

Build Type

Pull #726

github

Committed by liran-funaro

Commit Message

[utils] Correct the comments on writing to an optional channel output

#### Type of change

- Documentation update

#### Description

- `deliver` and `deliverorderer` treat a nil output channel as an output the caller does not want.
  Their 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.

#### Additional details (Optional)

No behavior change: comments only.

#722 also proposed an explicit discarding writer, so that an intentionally skipped write could be
told apart from a failed one. Dropped: no caller reads the result of a write to an optional output,
so there is nothing to disambiguate, and a nil output already reports the conservative answer.

#### Related issues

- resolves #722

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

Pull Request Pull Request #726: [utils] Correct the comments on writing to an optional channel output

Coverage Stats

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

25 existing lines in 10 files now uncovered.

10546 of 11571 relevant lines covered (91.14%)

33554.42 hits per line