From 94f514cd2096d811f90db5331f25cb85e0be0fd4 Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Tue, 14 Jan 2020 17:02:30 +0100 Subject: [PATCH] doc/battery: not an independently usable class There are only the instances on hubs that support it, and they are already documented there, so delete generic copy. --- doc/api/battery.rst | 8 -------- doc/api/index.rst | 1 - doc/api/signaltypes.rst | 6 ++---- 3 files changed, 2 insertions(+), 13 deletions(-) delete mode 100644 doc/api/battery.rst diff --git a/doc/api/battery.rst b/doc/api/battery.rst deleted file mode 100644 index ce59546..0000000 --- a/doc/api/battery.rst +++ /dev/null @@ -1,8 +0,0 @@ -Batteries -========= - - -The Battery Class -^^^^^^^^^^^^^^^^^ - -.. autoclass:: pybricks.builtins.Battery diff --git a/doc/api/index.rst b/doc/api/index.rst index 7ed37ac..af622bb 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -39,4 +39,3 @@ Intro frames motors sound - battery diff --git a/doc/api/signaltypes.rst b/doc/api/signaltypes.rst index 032bb5b..bde089a 100644 --- a/doc/api/signaltypes.rst +++ b/doc/api/signaltypes.rst @@ -185,8 +185,7 @@ voltage: mV -------------- Voltages are expressed in millivolt (mV). -For example, you can check the voltage of the :meth:`battery -<.builtins.Battery.voltage>`. +For example, you can check the voltage of the battery. .. _current: @@ -195,5 +194,4 @@ current: mA Electrical currents are expressed in milliampere (mA). -For example, you can check the current supplied by the :meth:`battery -<.builtins.Battery.current>`. +For example, you can check the current supplied by the battery.