M reflex-libtelnet/CHANGELOG.md => reflex-libtelnet/CHANGELOG.md +2 -2
@@ 16,8 16,8 @@
[`generic-lens`](https://hackage.haskell.org/package/generic-lens)
or
[`generic-optics`](https://hackage.haskell.org/package/generic-optics)
- to get lenses for your preferred flavour of optic.
- - Use the `field' @"fieldName"` version (i.e. not `#fieldName` or
+ to get lenses for your preferred flavour of optic. Make sure to
+ use the `field' @"fieldName"` version (i.e. not `#fieldName` or
un-primed `field`), otherwise GHC will struggle to infer the type
of `t` when setting fields in `ReflexConfig t`.
M reflex-libtelnet/README.md => reflex-libtelnet/README.md +11 -2
@@ 16,10 16,19 @@ the haddocks for this package.
streams that feed into a telnet state tracker. The easiest way to
do this is to call `newTelnetConfig` and overwrite the fields you
care about using record updates or lenses. You will almost
- certainly want to overwrite `_cRecv` to be the stream of incoming
- data from a socket, and `_cSend` to be the stream of outgoing data
+ certainly want to overwrite `recv` to be the stream of incoming
+ data from a socket, and `send` to be the stream of outgoing data
from your application.
+ * If you want to use lenses, use the
+ [`generic-lens`](https://hackage.haskell.org/package/generic-lens)
+ or
+ [`generic-optics`](https://hackage.haskell.org/package/generic-optics)
+ to get your preferred flavour of optic. Make sure to use the
+ `field' @"fieldName"` version (i.e. not `#fieldName` or un-primed
+ `field`), otherwise GHC will struggle to infer the type of `t`
+ when setting fields in `ReflexConfig t`.
+
2. Call `telnet config`, and save the resulting `TelnetEvents t`. This
structure holds the output event streams from a single telnet state
tracker.