Skip to content

Commit 777cd1c

Browse files
committed
Fix wrong raises documentation
The raises documentation needs to have `ExceptionType: description` form. Also improve the documentation slightly. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 5375c23 commit 777cd1c

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/frequenz/sdk/timeseries/_ringbuffer/serialization.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ def dump(
5858
file_format_version: Version of the file format, optional.
5959
6060
Raises:
61-
I/O related exceptions when the file cannot be written.
61+
OSError: When the file cannot be opened or written.
6262
"""
6363
with open(path, mode="wb+") as fileobj:
6464
pickle.dump((file_format_version, ringbuffer), fileobj)

0 commit comments

Comments
 (0)