From a3e3db3c37a2317e9a0027aaf877aa9cfcdf5303 Mon Sep 17 00:00:00 2001 From: Onyx and Iris Date: Thu, 27 Feb 2025 20:33:59 +0000 Subject: [PATCH] move callbacks/observer examples into examples/events/ --- examples/events/README.md | 8 ++++++++ examples/{ => events}/callbacks/README.md | 0 examples/{ => events}/callbacks/__main__.py | 0 examples/{ => events}/observer/README.md | 0 examples/{ => events}/observer/__main__.py | 0 5 files changed, 8 insertions(+) create mode 100644 examples/events/README.md rename examples/{ => events}/callbacks/README.md (100%) rename examples/{ => events}/callbacks/__main__.py (100%) rename examples/{ => events}/observer/README.md (100%) rename examples/{ => events}/observer/__main__.py (100%) diff --git a/examples/events/README.md b/examples/events/README.md new file mode 100644 index 0000000..7bf5ce9 --- /dev/null +++ b/examples/events/README.md @@ -0,0 +1,8 @@ +# Events + +If you want to receive updates on certain events there are two routes you can take: + +- Register a class that implements an `on_update(self, event) -> None` method on the `{Remote}.subect` class. +- Register callback functions/methods on the `{Remote}.subect` class, one for each type of update. + +Included are examples of both approaches. diff --git a/examples/callbacks/README.md b/examples/events/callbacks/README.md similarity index 100% rename from examples/callbacks/README.md rename to examples/events/callbacks/README.md diff --git a/examples/callbacks/__main__.py b/examples/events/callbacks/__main__.py similarity index 100% rename from examples/callbacks/__main__.py rename to examples/events/callbacks/__main__.py diff --git a/examples/observer/README.md b/examples/events/observer/README.md similarity index 100% rename from examples/observer/README.md rename to examples/events/observer/README.md diff --git a/examples/observer/__main__.py b/examples/events/observer/__main__.py similarity index 100% rename from examples/observer/__main__.py rename to examples/events/observer/__main__.py