Skip to content

Commit 79b40d1

Browse files
committed
docs/machine*: Remove explicit targets and "machine." prefixes on classes.
With currentmodule:: set properly, none are needed. Extra "machine." prefix produces wrong indexing data.
1 parent a0c296f commit 79b40d1

File tree

9 files changed

+10
-18
lines changed

9 files changed

+10
-18
lines changed

docs/library/machine.ADC.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
.. currentmodule:: machine
2-
.. _machine.ADC:
32

43
class ADC -- analog to digital conversion
54
=========================================
@@ -15,7 +14,7 @@ Usage::
1514
Constructors
1615
------------
1716

18-
.. class:: machine.ADC(id=0, \*, bits=12)
17+
.. class:: ADC(id=0, \*, bits=12)
1918

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

docs/library/machine.I2C.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
.. currentmodule:: machine
2-
.. _machine.I2C:
32

43
class I2C -- a two-wire serial protocol
54
=======================================
@@ -45,14 +44,14 @@ Constructors
4544

4645
.. only:: port_wipy
4746

48-
.. class:: machine.I2C(bus, ...)
47+
.. class:: I2C(bus, ...)
4948

5049
Construct an I2C object on the given bus. `bus` can only be 0.
5150
If the bus is not given, the default one will be selected (0).
5251

5352
.. only:: port_esp8266
5453

55-
.. class:: machine.I2C(scl, sda, \*, freq=400000)
54+
.. class:: I2C(scl, sda, \*, freq=400000)
5655

5756
Construct and return a new I2C object.
5857
See the init method below for a description of the arguments.

docs/library/machine.Pin.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Usage Model:
5858
Constructors
5959
------------
6060

61-
.. class:: machine.Pin(id, ...)
61+
.. class:: Pin(id, ...)
6262

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

docs/library/machine.RTC.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
.. currentmodule:: machine
2-
.. _machine.RTC:
32

43
class RTC -- real time clock
54
============================
@@ -17,7 +16,7 @@ Example usage::
1716
Constructors
1817
------------
1918

20-
.. class:: machine.RTC(id=0, ...)
19+
.. class:: RTC(id=0, ...)
2120

2221
Create an RTC object. See init for parameters of initialization.
2322

docs/library/machine.SD.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
.. currentmodule:: machine
2-
.. _machine.SD:
32

43
class SD -- secure digital memory card
54
======================================
@@ -25,7 +24,7 @@ Example usage::
2524
Constructors
2625
------------
2726

28-
.. class:: machine.SD(id,... )
27+
.. class:: SD(id,... )
2928

3029
Create a SD card object. See ``init()`` for parameters if initialization.
3130

docs/library/machine.SPI.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
.. currentmodule:: machine
2-
.. _machine.SPI:
32

43
class SPI -- a master-driven serial protocol
54
============================================
@@ -24,7 +23,7 @@ Constructors
2423

2524
.. only:: port_wipy
2625

27-
.. class:: machine.SPI(id, ...)
26+
.. class:: SPI(id, ...)
2827

2928
Construct an SPI object on the given bus. ``id`` can be only 0.
3029
With no additional parameters, the SPI object is created but not

docs/library/machine.Timer.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
.. currentmodule:: machine
2-
.. _machine.Timer:
32

43
class Timer -- control internal timers
54
======================================
@@ -60,7 +59,7 @@ class Timer -- control internal timers
6059
Constructors
6160
------------
6261

63-
.. class:: machine.Timer(id, ...)
62+
.. class:: Timer(id, ...)
6463

6564
.. only:: port_wipy
6665

docs/library/machine.UART.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
.. currentmodule:: machine
2-
.. _machine.UART:
32

43
class UART -- duplex serial communication bus
54
=============================================
@@ -59,7 +58,7 @@ Constructors
5958

6059
.. only:: port_wipy
6160

62-
.. class:: machine.UART(bus, ...)
61+
.. class:: UART(bus, ...)
6362

6463
Construct a UART object on the given bus. ``bus`` can be 0 or 1.
6564
If the bus is not given, the default one will be selected (0) or the selection

docs/library/machine.WDT.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
.. currentmodule:: machine
2-
.. _machine.WDT:
32

43
class WDT -- watchdog timer
54
===========================
@@ -18,7 +17,7 @@ Example usage::
1817
Constructors
1918
------------
2019

21-
.. class:: machine.WDT(id=0, timeout=5000)
20+
.. class:: WDT(id=0, timeout=5000)
2221

2322
Create a WDT object and start it. The timeout must be given in seconds and
2423
the minimum value that is accepted is 1 second. Once it is running the timeout

0 commit comments

Comments
 (0)