Skip to content

Commit 913fc59

Browse files
committed
chore: update doc strings
1 parent ae6ed75 commit 913fc59

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

src/firebase_functions/pubsub_fn.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ def example(event: CloudEvent[MessagePublishedData[object]]) -> None:
171171
:type \\*\\*kwargs: as :exc:`firebase_functions.options.PubSubOptions`
172172
:rtype: :exc:`typing.Callable`
173173
\\[ \\[ :exc:`firebase_functions.core.CloudEvent` \\[
174-
:exc:`firebase_functions.pubsub.MessagePublishedData` \\[
174+
:exc:`firebase_functions.pubsub_fn.MessagePublishedData` \\[
175175
:exc:`typing.Any` \\] \\] \\], `None` \\]
176176
A function that takes a CloudEvent and returns None.
177177
"""

src/firebase_functions/remote_config_fn.py

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,25 @@ def _config_handler(func: _C1, raw: _ce.CloudEvent) -> None:
188188

189189
@_util.copy_func_kwargs(EventHandlerOptions)
190190
def on_config_updated(**kwargs) -> _typing.Callable[[_C1], _C1]:
191+
"""
192+
Event handler which triggers when data is updated in a Remote Config.
193+
194+
Example:
195+
196+
.. code-block:: python
197+
198+
@on_config_updated()
199+
def example(event: CloudEvent[ConfigUpdateData]) -> None:
200+
pass
201+
202+
:param \\*\\*kwargs: Pub/Sub options.
203+
:type \\*\\*kwargs: as :exc:`firebase_functions.options.EventHandlerOptions`
204+
:rtype: :exc:`typing.Callable`
205+
\\[ \\[ :exc:`firebase_functions.core.CloudEvent` \\[
206+
:exc:`firebase_functions.remote_config_fn.ConfigUpdateData` \\[
207+
:exc:`typing.Any` \\] \\] \\], `None` \\]
208+
A function that takes a CloudEvent and returns None.
209+
"""
191210
options = EventHandlerOptions(**kwargs)
192211

193212
def on_config_updated_inner_decorator(func: _C1):

0 commit comments

Comments
 (0)