Skip to content

Commit 9175482

Browse files
committed
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 <[email protected]>
1 parent 89e1e67 commit 9175482

18 files changed

+19
-19
lines changed

Diff for: docs/library/pyb.ADC.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Usage::
2323
Constructors
2424
------------
2525

26-
.. class:: pyb.ADC(pin)
26+
.. class:: ADC(pin)
2727

2828
Create an ADC object associated with the given pin.
2929
This allows you to then read analog values on that pin.

Diff for: docs/library/pyb.Accel.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Raw values are between -32 and 31.
1616
Constructors
1717
------------
1818

19-
.. class:: pyb.Accel()
19+
.. class:: Accel()
2020

2121
Create and return an accelerometer object.
2222

Diff for: docs/library/pyb.CAN.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ for both classic and FD CAN controllers, unless otherwise stated.
3131
Constructors
3232
------------
3333

34-
.. class:: pyb.CAN(bus, ...)
34+
.. class:: CAN(bus, ...)
3535

3636
Construct a CAN object on the given bus. *bus* can be 1-2, or ``'YA'`` or ``'YB'``.
3737
With no additional parameters, the CAN object is created but not

Diff for: docs/library/pyb.DAC.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ To output a continuous sine-wave at 12-bit resolution::
4949
Constructors
5050
------------
5151

52-
.. class:: pyb.DAC(port, bits=8, *, buffering=None)
52+
.. class:: DAC(port, bits=8, *, buffering=None)
5353

5454
Construct a new DAC object.
5555

Diff for: docs/library/pyb.ExtInt.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ usrsw.h for an example of using this.
5151
Constructors
5252
------------
5353

54-
.. class:: pyb.ExtInt(pin, mode, pull, callback)
54+
.. class:: ExtInt(pin, mode, pull, callback)
5555

5656
Create an ExtInt object:
5757

Diff for: docs/library/pyb.Flash.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ application.
1515
Constructors
1616
------------
1717

18-
.. class:: pyb.Flash()
18+
.. class:: Flash()
1919

2020
Create and return a block device that represents the flash device presented
2121
to the USB mass storage interface.
@@ -25,7 +25,7 @@ Constructors
2525

2626
This constructor is deprecated and will be removed in a future version of MicroPython.
2727

28-
.. class:: pyb.Flash(*, start=-1, len=-1)
28+
.. class:: Flash(*, start=-1, len=-1)
2929
:noindex:
3030

3131
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 for: docs/library/pyb.I2C.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Master also has other methods::
5656
Constructors
5757
------------
5858

59-
.. class:: pyb.I2C(bus, ...)
59+
.. class:: I2C(bus, ...)
6060

6161
Construct an I2C object on the given bus. ``bus`` can be 1 or 2, 'X' or
6262
'Y'. With no additional parameters, the I2C object is created but not

Diff for: docs/library/pyb.LCD.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ For example, to make a bouncing dot, try::
4141
Constructors
4242
------------
4343

44-
.. class:: pyb.LCD(skin_position)
44+
.. class:: LCD(skin_position)
4545

4646
Construct an LCD object in the given skin position. ``skin_position`` can be 'X' or 'Y', and
4747
should match the position where the LCD pyskin is plugged in.

Diff for: docs/library/pyb.LED.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The LED object controls an individual LED (Light Emitting Diode).
1010
Constructors
1111
------------
1212

13-
.. class:: pyb.LED(id)
13+
.. class:: LED(id)
1414

1515
Create an LED object associated with the given LED:
1616

Diff for: docs/library/pyb.Pin.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ gpio pins.
7474
Constructors
7575
------------
7676

77-
.. class:: pyb.Pin(id, ...)
77+
.. class:: Pin(id, ...)
7878

7979
Create a new Pin object associated with the id. If additional arguments are given,
8080
they are used to initialise the pin. See :meth:`pin.init`.

Diff for: docs/library/pyb.RTC.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Example usage::
1717
Constructors
1818
------------
1919

20-
.. class:: pyb.RTC()
20+
.. class:: RTC()
2121

2222
Create an RTC object.
2323

Diff for: docs/library/pyb.SPI.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Additional methods for SPI::
2828
Constructors
2929
------------
3030

31-
.. class:: pyb.SPI(bus, ...)
31+
.. class:: SPI(bus, ...)
3232

3333
Construct an SPI object on the given bus. ``bus`` can be 1 or 2, or
3434
'X' or 'Y'. With no additional parameters, the SPI object is created but

Diff for: docs/library/pyb.Servo.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Example usage::
3030
Constructors
3131
------------
3232

33-
.. class:: pyb.Servo(id)
33+
.. class:: Servo(id)
3434

3535
Create a servo object. ``id`` is 1-4, and corresponds to pins X1 through X4.
3636

Diff for: docs/library/pyb.Switch.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Example::
2323
Constructors
2424
------------
2525

26-
.. class:: pyb.Switch()
26+
.. class:: Switch()
2727

2828
Create and return a switch object.
2929

Diff for: docs/library/pyb.Timer.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ limitation.
5353
Constructors
5454
------------
5555

56-
.. class:: pyb.Timer(id, ...)
56+
.. class:: Timer(id, ...)
5757

5858
Construct a new timer object of the given id. If additional
5959
arguments are given, then the timer is initialised by ``init(...)``.

Diff for: docs/library/pyb.UART.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Earlier versions use ``uart.send`` and ``uart.recv``.
4646
Constructors
4747
------------
4848

49-
.. class:: pyb.UART(bus, ...)
49+
.. class:: UART(bus, ...)
5050

5151
Construct a UART object on the given bus.
5252
For Pyboard ``bus`` can be 1-4, 6, 'XA', 'XB', 'YA', or 'YB'.

Diff for: docs/library/pyb.USB_HID.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Before you can use this class, you need to use :meth:`pyb.usb_mode()` to set the
1313
Constructors
1414
------------
1515

16-
.. class:: pyb.USB_HID()
16+
.. class:: USB_HID()
1717

1818
Create a new USB_HID object.
1919

Diff for: docs/library/pyb.USB_VCP.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ the connected host.
1212
Constructors
1313
------------
1414

15-
.. class:: pyb.USB_VCP(id=0)
15+
.. class:: USB_VCP(id=0)
1616

1717
Create a new USB_VCP object. The *id* argument specifies which USB VCP port to
1818
use.

0 commit comments

Comments
 (0)