telemere/main/resources/signal-docstrings
Peter Taoussanis ac5feb4723 [mod] [#53] Breaking: change return value of log!, event!
This change will only affect rare advanced users that depend on
the return value of `log!` or `event!`. For all other users this
will be a non-breaking change.

Before this commit:
  `log!` and `event!` returned true iff signal was allowed.

After this commit:
  `log!`  and `event!` now ALWAYS return nil.
  `log!?` and `event!?` have been added that keep the old behaviour.

Motivation:
  It's pretty rare to use the return value when generating log or event
  signals. I originally included the return value since it CAN be handy,
  and I figured it could just be ignored by those that don't need it.

  But #53 showed that there's a downside I hadn't anticipated - some
  users may actually depend on / prefer a nil return to prevent
  accidentally affecting program flow.

  I think that's a legitimate enough concern to still make a change now
  before v1 final.

  Apologies for the nuissance!
2025-03-03 11:19:36 +01:00
..
catch-to-error!.txt [mod] [#53] Breaking: change return value of log!, event! 2025-03-03 11:19:36 +01:00
environmental-config.txt [doc] Misc improvements 2025-02-12 09:18:44 +01:00
error!.txt [mod] [#53] Breaking: change return value of log!, event! 2025-03-03 11:19:36 +01:00
event!.txt [mod] [#53] Breaking: change return value of log!, event! 2025-03-03 11:19:36 +01:00
log!.txt [mod] [#53] Breaking: change return value of log!, event! 2025-03-03 11:19:36 +01:00
signal!.txt [mod] [#53] Breaking: change return value of log!, event! 2025-03-03 11:19:36 +01:00
signal-content.txt [doc] Rename "signal filters" -> "call filters", etc. 2025-02-27 12:45:01 +01:00
signal-creators.txt [mod] [#53] Breaking: change return value of log!, event! 2025-03-03 11:19:36 +01:00
signal-options.txt [doc] Rename "signal filters" -> "call filters", etc. 2025-02-27 12:45:01 +01:00
spy!.txt [mod] [#53] Breaking: change return value of log!, event! 2025-03-03 11:19:36 +01:00
trace!.txt [mod] [#53] Breaking: change return value of log!, event! 2025-03-03 11:19:36 +01:00