telemere/wiki
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
..
.gitignore [new] Add initial code, content 2024-03-08 10:35:10 +01:00
1-Getting-started.md [mod] [#53] Breaking: change return value of log!, event! 2025-03-03 11:19:36 +01:00
2-Architecture.md [doc] Rename "signal filters" -> "call filters", etc. 2025-02-27 12:45:01 +01:00
3-Config.md [doc] Rename "signal filters" -> "call filters", etc. 2025-02-27 12:45:01 +01:00
4-Handlers.md [doc] Misc improvements 2025-02-12 09:18:44 +01:00
5-Migrating.md [new] Add timbre->telemere appender and update docs 2024-12-23 11:19:05 +01:00
6-FAQ.md [doc] Misc improvements 2025-01-22 14:52:38 +01:00
7-Tips.md [doc] Rename "signal filters" -> "call filters", etc. 2025-02-27 12:45:01 +01:00
8-Community.md [doc] [#33] Add community examples link to Bling Gist 2024-12-24 10:35:07 +01:00
9-Authors.md [mod] [#39] Remove shell API 2024-12-22 13:58:03 +01:00
Home.md [doc] Documentation work 2024-04-17 15:51:24 +02:00
README.md [new] Add initial code, content 2024-03-08 10:35:10 +01:00

Attention!

This wiki is designed for viewing from here!

Viewing from GitHub's file browser will result in broken links.