`Df.void` documentation mismatch

[t-wallet]

The documentation of Df.void states that it never acknowledges data, but the implementation acknowledges data if the reset is deasserted.

[DigitalBrains1]

Its original documentation was probably intended to be:
https://github.com/clash-lang/clash-protocols/pull/21/files#diff-67d2b81a42db4e0ee27ab6bb3b32e02ff4a4b42b01c6e9809ffd2120f2cb37bfR238-R245

-- | Ignore incoming data

But in that PR, although that was the doc for DfLike, the doc for Df was inadvertently copied from pure.

Wouldn't always eating and discarding the data make most sense? That way you can, indeed, ignore data, instead of a rapidly propagating back pressure that is never eased. So it's the doc that needs to be changed, not the implementation.

[t-wallet]

That makes sense. I don't really see what the purpose of never acknowledging data is either. In that case, I believe Df.void can be removed as we already have Df.consume which serves the same purpose.

[DigitalBrains1]

There's an interesting implementation difference between the two, though, as consume also acknowledges data in reset.

[martijnbastiaan]

That makes sense. I don't really see what the purpose of never acknowledging data is either.

If this is the prevailing opinion, then we probably should change IdleCircuit too:

{- | Idle state of a Circuit. Aims to provide no data for both the forward and
backward direction. Transactions are not acknowledged.
-}
class (Protocol p) => IdleCircuit p where
  idleFwd :: Proxy p -> Fwd (p :: Type)
  idleBwd :: Proxy p -> Bwd (p :: Type)