[Battery Current] Fix sphinx doc.
Fix doc string format for sphinx.
BUG=None
TEST=make doc and see the output result
Change-Id: I7de08e0f53983be4c8cf572b4b0dff470e62ee58
Reviewed-on: https://chromium-review.googlesource.com/322067
Commit-Ready: Hsu Wei-Cheng <mojahsu@chromium.org>
Tested-by: Hsu Wei-Cheng <mojahsu@chromium.org>
Reviewed-by: Hung-Te Lin <hungte@chromium.org>
diff --git a/py/test/pytests/battery_current.py b/py/test/pytests/battery_current.py
index 17fdf9e..5de2f3f 100644
--- a/py/test/pytests/battery_current.py
+++ b/py/test/pytests/battery_current.py
@@ -62,13 +62,15 @@
Arg('usbpd_info', tuple, textwrap.dedent("""
(usbpd_port, usbpd_port_prompt, min_millivolt) Used to select a
particular port from a multi-port DUT.
- usbpd_port: (int) usbpd_port number. Specify which port to insert
- power line.
- usbpd_port_prompt_en: (str) prompt operator which port to insert in
- English
- usbpd_port_prompt_zh: (str) prompt operator which port to insert in
- Chinese.
- min_millivolt: (int) The minimum millivolt the power must provide
+
+ * ``usbpd_port``: (int) usbpd_port number. Specify which port to
+ insert power line.
+ * ``usbpd_port_prompt_en``: (str) prompt operator which port to
+ insert in English
+ * ``usbpd_port_prompt_zh``: (str) prompt operator which port to
+ insert in Chinese.
+ * ``min_millivolt``: (int) The minimum millivolt the power must
+ provide
"""),
optional=True)
]
