From 597bd22547f1f3e50dd22626a90d6fbd08dbb55b Mon Sep 17 00:00:00 2001 From: Oliver Silvester Date: Wed, 20 Sep 2023 09:03:16 +0000 Subject: [PATCH] fix docs --- src/ophyd_async/core/_device/device_save_loader.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/ophyd_async/core/_device/device_save_loader.py b/src/ophyd_async/core/_device/device_save_loader.py index 00b02d2838..7a71b6265a 100644 --- a/src/ophyd_async/core/_device/device_save_loader.py +++ b/src/ophyd_async/core/_device/device_save_loader.py @@ -52,12 +52,11 @@ def save_device(device: Device, savename: str, ignore: List[str] = []): Plan to save the setup of a device by getting a list of its signals and their readback values. - Store the output to `savename.yaml`. + Store the output to a yaml file ``savename.yaml`` Parameters ---------- - device : Savable - Ophyd device which implements the `sort_signal_by_phase` method. + device : Device savename : str Name of the YAML file. @@ -68,7 +67,7 @@ def save_device(device: Device, savename: str, ignore: List[str] = []): Yields ------ msg : Msg - `locate`, `*signals` + ``locate``, ``*signals`` See Also --------