summaryrefslogtreecommitdiff
path: root/docs/library
diff options
context:
space:
mode:
authorDamien George <damien@micropython.org>2022-06-21 14:33:23 +1000
committerDamien George <damien@micropython.org>2022-06-21 14:33:23 +1000
commit9175482f29264b017534902bb65e23a2d6485006 (patch)
tree8014f2a96218f478faf1753b92c7a8c6c34a3eca /docs/library
parent89e1e67748e681da5f414dc597e89eaee8822817 (diff)
docs/library: Remove unnecessary "pyb." prefix on class names.
Otherwise these classes are refered to with a double prefix, like pyb.pyb.ADC. Signed-off-by: Damien George <damien@micropython.org>
Diffstat (limited to 'docs/library')
-rw-r--r--docs/library/pyb.ADC.rst2
-rw-r--r--docs/library/pyb.Accel.rst2
-rw-r--r--docs/library/pyb.CAN.rst2
-rw-r--r--docs/library/pyb.DAC.rst2
-rw-r--r--docs/library/pyb.ExtInt.rst2
-rw-r--r--docs/library/pyb.Flash.rst4
-rw-r--r--docs/library/pyb.I2C.rst2
-rw-r--r--docs/library/pyb.LCD.rst2
-rw-r--r--docs/library/pyb.LED.rst2
-rw-r--r--docs/library/pyb.Pin.rst2
-rw-r--r--docs/library/pyb.RTC.rst2
-rw-r--r--docs/library/pyb.SPI.rst2
-rw-r--r--docs/library/pyb.Servo.rst2
-rw-r--r--docs/library/pyb.Switch.rst2
-rw-r--r--docs/library/pyb.Timer.rst2
-rw-r--r--docs/library/pyb.UART.rst2
-rw-r--r--docs/library/pyb.USB_HID.rst2
-rw-r--r--docs/library/pyb.USB_VCP.rst2
18 files changed, 19 insertions, 19 deletions
diff --git a/docs/library/pyb.ADC.rst b/docs/library/pyb.ADC.rst
index 1b16e0c2f..9410e5194 100644
--- a/docs/library/pyb.ADC.rst
+++ b/docs/library/pyb.ADC.rst
@@ -23,7 +23,7 @@ Usage::
Constructors
------------
-.. class:: pyb.ADC(pin)
+.. class:: ADC(pin)
Create an ADC object associated with the given pin.
This allows you to then read analog values on that pin.
diff --git a/docs/library/pyb.Accel.rst b/docs/library/pyb.Accel.rst
index d5c0ca863..7f5c60f4c 100644
--- a/docs/library/pyb.Accel.rst
+++ b/docs/library/pyb.Accel.rst
@@ -16,7 +16,7 @@ Raw values are between -32 and 31.
Constructors
------------
-.. class:: pyb.Accel()
+.. class:: Accel()
Create and return an accelerometer object.
diff --git a/docs/library/pyb.CAN.rst b/docs/library/pyb.CAN.rst
index 69704d09b..54377091d 100644
--- a/docs/library/pyb.CAN.rst
+++ b/docs/library/pyb.CAN.rst
@@ -31,7 +31,7 @@ for both classic and FD CAN controllers, unless otherwise stated.
Constructors
------------
-.. class:: pyb.CAN(bus, ...)
+.. class:: CAN(bus, ...)
Construct a CAN object on the given bus. *bus* can be 1-2, or ``'YA'`` or ``'YB'``.
With no additional parameters, the CAN object is created but not
diff --git a/docs/library/pyb.DAC.rst b/docs/library/pyb.DAC.rst
index 0eb469bef..aa7934289 100644
--- a/docs/library/pyb.DAC.rst
+++ b/docs/library/pyb.DAC.rst
@@ -49,7 +49,7 @@ To output a continuous sine-wave at 12-bit resolution::
Constructors
------------
-.. class:: pyb.DAC(port, bits=8, *, buffering=None)
+.. class:: DAC(port, bits=8, *, buffering=None)
Construct a new DAC object.
diff --git a/docs/library/pyb.ExtInt.rst b/docs/library/pyb.ExtInt.rst
index 7741cc51e..f49fbb1a1 100644
--- a/docs/library/pyb.ExtInt.rst
+++ b/docs/library/pyb.ExtInt.rst
@@ -51,7 +51,7 @@ usrsw.h for an example of using this.
Constructors
------------
-.. class:: pyb.ExtInt(pin, mode, pull, callback)
+.. class:: ExtInt(pin, mode, pull, callback)
Create an ExtInt object:
diff --git a/docs/library/pyb.Flash.rst b/docs/library/pyb.Flash.rst
index 01b3a0ac9..984e13f45 100644
--- a/docs/library/pyb.Flash.rst
+++ b/docs/library/pyb.Flash.rst
@@ -15,7 +15,7 @@ application.
Constructors
------------
-.. class:: pyb.Flash()
+.. class:: Flash()
Create and return a block device that represents the flash device presented
to the USB mass storage interface.
@@ -25,7 +25,7 @@ Constructors
This constructor is deprecated and will be removed in a future version of MicroPython.
-.. class:: pyb.Flash(*, start=-1, len=-1)
+.. class:: Flash(*, start=-1, len=-1)
:noindex:
Create and return a block device that accesses the flash at the specified offset. The length defaults to the remaining size of the device.
diff --git a/docs/library/pyb.I2C.rst b/docs/library/pyb.I2C.rst
index f60b50686..24b9cb8c3 100644
--- a/docs/library/pyb.I2C.rst
+++ b/docs/library/pyb.I2C.rst
@@ -56,7 +56,7 @@ Master also has other methods::
Constructors
------------
-.. class:: pyb.I2C(bus, ...)
+.. class:: I2C(bus, ...)
Construct an I2C object on the given bus. ``bus`` can be 1 or 2, 'X' or
'Y'. With no additional parameters, the I2C object is created but not
diff --git a/docs/library/pyb.LCD.rst b/docs/library/pyb.LCD.rst
index 018902ca6..ba394d36a 100644
--- a/docs/library/pyb.LCD.rst
+++ b/docs/library/pyb.LCD.rst
@@ -41,7 +41,7 @@ For example, to make a bouncing dot, try::
Constructors
------------
-.. class:: pyb.LCD(skin_position)
+.. class:: LCD(skin_position)
Construct an LCD object in the given skin position. ``skin_position`` can be 'X' or 'Y', and
should match the position where the LCD pyskin is plugged in.
diff --git a/docs/library/pyb.LED.rst b/docs/library/pyb.LED.rst
index d3ab965e7..de07c7d1c 100644
--- a/docs/library/pyb.LED.rst
+++ b/docs/library/pyb.LED.rst
@@ -10,7 +10,7 @@ The LED object controls an individual LED (Light Emitting Diode).
Constructors
------------
-.. class:: pyb.LED(id)
+.. class:: LED(id)
Create an LED object associated with the given LED:
diff --git a/docs/library/pyb.Pin.rst b/docs/library/pyb.Pin.rst
index 33b994e39..d13cb9741 100644
--- a/docs/library/pyb.Pin.rst
+++ b/docs/library/pyb.Pin.rst
@@ -74,7 +74,7 @@ gpio pins.
Constructors
------------
-.. class:: pyb.Pin(id, ...)
+.. class:: Pin(id, ...)
Create a new Pin object associated with the id. If additional arguments are given,
they are used to initialise the pin. See :meth:`pin.init`.
diff --git a/docs/library/pyb.RTC.rst b/docs/library/pyb.RTC.rst
index c477e7f03..040b1fe6b 100644
--- a/docs/library/pyb.RTC.rst
+++ b/docs/library/pyb.RTC.rst
@@ -17,7 +17,7 @@ Example usage::
Constructors
------------
-.. class:: pyb.RTC()
+.. class:: RTC()
Create an RTC object.
diff --git a/docs/library/pyb.SPI.rst b/docs/library/pyb.SPI.rst
index 14b90a224..4903a2c33 100644
--- a/docs/library/pyb.SPI.rst
+++ b/docs/library/pyb.SPI.rst
@@ -28,7 +28,7 @@ Additional methods for SPI::
Constructors
------------
-.. class:: pyb.SPI(bus, ...)
+.. class:: SPI(bus, ...)
Construct an SPI object on the given bus. ``bus`` can be 1 or 2, or
'X' or 'Y'. With no additional parameters, the SPI object is created but
diff --git a/docs/library/pyb.Servo.rst b/docs/library/pyb.Servo.rst
index b3ce71d11..c52ee705f 100644
--- a/docs/library/pyb.Servo.rst
+++ b/docs/library/pyb.Servo.rst
@@ -30,7 +30,7 @@ Example usage::
Constructors
------------
-.. class:: pyb.Servo(id)
+.. class:: Servo(id)
Create a servo object. ``id`` is 1-4, and corresponds to pins X1 through X4.
diff --git a/docs/library/pyb.Switch.rst b/docs/library/pyb.Switch.rst
index 1edcbf848..9ddf8c417 100644
--- a/docs/library/pyb.Switch.rst
+++ b/docs/library/pyb.Switch.rst
@@ -23,7 +23,7 @@ Example::
Constructors
------------
-.. class:: pyb.Switch()
+.. class:: Switch()
Create and return a switch object.
diff --git a/docs/library/pyb.Timer.rst b/docs/library/pyb.Timer.rst
index 639ae1dcd..53213666b 100644
--- a/docs/library/pyb.Timer.rst
+++ b/docs/library/pyb.Timer.rst
@@ -53,7 +53,7 @@ limitation.
Constructors
------------
-.. class:: pyb.Timer(id, ...)
+.. class:: Timer(id, ...)
Construct a new timer object of the given id. If additional
arguments are given, then the timer is initialised by ``init(...)``.
diff --git a/docs/library/pyb.UART.rst b/docs/library/pyb.UART.rst
index e1735403c..2bd9c6b34 100644
--- a/docs/library/pyb.UART.rst
+++ b/docs/library/pyb.UART.rst
@@ -46,7 +46,7 @@ Earlier versions use ``uart.send`` and ``uart.recv``.
Constructors
------------
-.. class:: pyb.UART(bus, ...)
+.. class:: UART(bus, ...)
Construct a UART object on the given bus.
For Pyboard ``bus`` can be 1-4, 6, 'XA', 'XB', 'YA', or 'YB'.
diff --git a/docs/library/pyb.USB_HID.rst b/docs/library/pyb.USB_HID.rst
index 7e23d1313..80162cc56 100644
--- a/docs/library/pyb.USB_HID.rst
+++ b/docs/library/pyb.USB_HID.rst
@@ -13,7 +13,7 @@ Before you can use this class, you need to use :meth:`pyb.usb_mode()` to set the
Constructors
------------
-.. class:: pyb.USB_HID()
+.. class:: USB_HID()
Create a new USB_HID object.
diff --git a/docs/library/pyb.USB_VCP.rst b/docs/library/pyb.USB_VCP.rst
index 1cca8dcad..17d2ecff4 100644
--- a/docs/library/pyb.USB_VCP.rst
+++ b/docs/library/pyb.USB_VCP.rst
@@ -12,7 +12,7 @@ the connected host.
Constructors
------------
-.. class:: pyb.USB_VCP(id=0)
+.. class:: USB_VCP(id=0)
Create a new USB_VCP object. The *id* argument specifies which USB VCP port to
use.