Skip to content

Commit 78204af

Browse files
committed
adds more detail to SampleEvent docstring 📖
1 parent f747248 commit 78204af

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

lambda_sample_events/sample_event.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,18 @@
2323
]
2424

2525
class SampleEvent(object):
26-
""" Generates a sample event for the given service name """
26+
"""
27+
Generates a sample event for the given service name
28+
29+
Args:
30+
service_name (str): The name of a supported service. See README.md.
31+
32+
Attributes:
33+
event (str): Returns a JSON event for the specified service.
34+
35+
Raises:
36+
UnknownServiceError: An unsupported service name was used. See README.md.
37+
"""
2738
def __init__(self, service_name):
2839
self.event = SampleEvent.load_event(service_name)
2940

0 commit comments

Comments
 (0)