Skip to content

Commit 6441719

Browse files
committed
Include TimeoutError in raises docstring field
1 parent e924217 commit 6441719

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

snekbox/memfs.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,9 @@ def files(
138138
exclude_files: A dict of Paths and last modified times.
139139
Files will be excluded if their last modified time
140140
is equal to the provided value.
141-
timeout: The maximum time for the file parsing. If exceeded,
142-
a TimeoutError will be raised.
141+
timeout: Maximum time in seconds for file parsing.
142+
Raises:
143+
TimeoutError: If file parsing exceeds timeout.
143144
"""
144145
start_time = time.monotonic()
145146
count = 0
@@ -184,10 +185,11 @@ def files_list(
184185
Files will be excluded if their last modified time
185186
is equal to the provided value.
186187
preload_dict: Whether to preload as_dict property data.
187-
timeout: The maximum time for the file parsing. If exceeded,
188-
a TimeoutError will be raised.
188+
timeout: Maximum time in seconds for file parsing.
189189
Returns:
190190
List of FileAttachments sorted lexically by path name.
191+
Raises:
192+
TimeoutError: If file parsing exceeds timeout.
191193
"""
192194
start_time = time.monotonic()
193195
res = sorted(

0 commit comments

Comments
 (0)