From 9616e0dc415d246e1a73d7f82f581a29223c85af Mon Sep 17 00:00:00 2001 From: Izaak Gough Date: Fri, 16 Oct 2026 16:17:55 +0100 Subject: [PATCH] docs: describe on_schedule as a Cloud Scheduler trigger --- src/firebase_functions/scheduler_fn.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/firebase_functions/scheduler_fn.py b/src/firebase_functions/scheduler_fn.py index 995228d..8fa3eed 100644 --- a/src/firebase_functions/scheduler_fn.py +++ b/src/firebase_functions/scheduler_fn.py @@ -42,7 +42,7 @@ @_dataclasses.dataclass(frozen=True) class ScheduledEvent: """ - A ``ScheduleEvent`` that is passed to the function handler. + A ``ScheduledEvent`` that is passed to the function handler. """ job_name: str | None @@ -69,8 +69,8 @@ class ScheduledEvent: @_util.copy_func_kwargs(_options.ScheduleOptions) def on_schedule(**kwargs) -> _typing.Callable[[_C], _Response]: """ - Creates a handler for tasks sent to a Google Cloud Tasks queue. - Requires a function that takes a ``CallableRequest``. + Creates a handler that runs on a schedule, triggered by a Cloud Scheduler job. + Requires a function that takes a ``ScheduledEvent``. Example: @@ -91,7 +91,7 @@ def example(event: scheduler_fn.ScheduledEvent) -> None: :param \\*\\*kwargs: `ScheduleOptions` options. :type \\*\\*kwargs: as :exc:`firebase_functions.options.ScheduleOptions` :rtype: :exc:`typing.Callable` - \\[ \\[ :exc:`firebase_functions.schedule_fn.ScheduledEvent` \\], :exc:`None` \\] + \\[ \\[ :exc:`firebase_functions.scheduler_fn.ScheduledEvent` \\], :exc:`None` \\] A function that takes a ``ScheduledEvent`` and returns nothing. """ options = _options.ScheduleOptions(**kwargs)