From 79b40d11276b2b70b2eaa2fe0cac4d3d830c19e4 Mon Sep 17 00:00:00 2001
From: Paul Sokolovsky <pfalcon@users.sourceforge.net>
Date: Thu, 9 Jun 2016 03:03:53 +0300
Subject: [PATCH] docs/machine*: Remove explicit targets and "machine."
prefixes on classes.
With currentmodule:: set properly, none are needed. Extra "machine." prefix
produces wrong indexing data.
---
docs/library/machine.ADC.rst | 3 +--
docs/library/machine.I2C.rst | 5 ++---
docs/library/machine.Pin.rst | 2 +-
docs/library/machine.RTC.rst | 3 +--
docs/library/machine.SD.rst | 3 +--
docs/library/machine.SPI.rst | 3 +--
docs/library/machine.Timer.rst | 3 +--
docs/library/machine.UART.rst | 3 +--
docs/library/machine.WDT.rst | 3 +--
9 files changed, 10 insertions(+), 18 deletions(-)
diff --git a/docs/library/machine.ADC.rst b/docs/library/machine.ADC.rst
index 11381e98b..2752878ff 100644
--- a/docs/library/machine.ADC.rst
+++ b/docs/library/machine.ADC.rst
@@ -1,5 +1,4 @@
.. currentmodule:: machine
-.. _machine.ADC:
class ADC -- analog to digital conversion
=========================================
@@ -15,7 +14,7 @@ Usage::
Constructors
------------
-.. class:: machine.ADC(id=0, \*, bits=12)
+.. class:: ADC(id=0, \*, bits=12)
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/machine.I2C.rst b/docs/library/machine.I2C.rst
index 2f020f6d4..b3bfa68f0 100644
--- a/docs/library/machine.I2C.rst
+++ b/docs/library/machine.I2C.rst
@@ -1,5 +1,4 @@
.. currentmodule:: machine
-.. _machine.I2C:
class I2C -- a two-wire serial protocol
=======================================
@@ -45,14 +44,14 @@ Constructors
.. only:: port_wipy
- .. class:: machine.I2C(bus, ...)
+ .. class:: I2C(bus, ...)
Construct an I2C object on the given bus. `bus` can only be 0.
If the bus is not given, the default one will be selected (0).
.. only:: port_esp8266
- .. class:: machine.I2C(scl, sda, \*, freq=400000)
+ .. class:: I2C(scl, sda, \*, freq=400000)
Construct and return a new I2C object.
See the init method below for a description of the arguments.
diff --git a/docs/library/machine.Pin.rst b/docs/library/machine.Pin.rst
index 21e5323d5..fdada2f38 100644
--- a/docs/library/machine.Pin.rst
+++ b/docs/library/machine.Pin.rst
@@ -58,7 +58,7 @@ Usage Model:
Constructors
------------
-.. class:: machine.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/machine.RTC.rst b/docs/library/machine.RTC.rst
index 219ca273d..b6e98e9d1 100644
--- a/docs/library/machine.RTC.rst
+++ b/docs/library/machine.RTC.rst
@@ -1,5 +1,4 @@
.. currentmodule:: machine
-.. _machine.RTC:
class RTC -- real time clock
============================
@@ -17,7 +16,7 @@ Example usage::
Constructors
------------
-.. class:: machine.RTC(id=0, ...)
+.. class:: RTC(id=0, ...)
Create an RTC object. See init for parameters of initialization.
diff --git a/docs/library/machine.SD.rst b/docs/library/machine.SD.rst
index 330ef217a..21c28aa20 100644
--- a/docs/library/machine.SD.rst
+++ b/docs/library/machine.SD.rst
@@ -1,5 +1,4 @@
.. currentmodule:: machine
-.. _machine.SD:
class SD -- secure digital memory card
======================================
@@ -25,7 +24,7 @@ Example usage::
Constructors
------------
-.. class:: machine.SD(id,... )
+.. class:: SD(id,... )
Create a SD card object. See ``init()`` for parameters if initialization.
diff --git a/docs/library/machine.SPI.rst b/docs/library/machine.SPI.rst
index 8e6666076..f3c95181d 100644
--- a/docs/library/machine.SPI.rst
+++ b/docs/library/machine.SPI.rst
@@ -1,5 +1,4 @@
.. currentmodule:: machine
-.. _machine.SPI:
class SPI -- a master-driven serial protocol
============================================
@@ -24,7 +23,7 @@ Constructors
.. only:: port_wipy
- .. class:: machine.SPI(id, ...)
+ .. class:: SPI(id, ...)
Construct an SPI object on the given bus. ``id`` can be only 0.
With no additional parameters, the SPI object is created but not
diff --git a/docs/library/machine.Timer.rst b/docs/library/machine.Timer.rst
index 0e596588e..344d1ea86 100644
--- a/docs/library/machine.Timer.rst
+++ b/docs/library/machine.Timer.rst
@@ -1,5 +1,4 @@
.. currentmodule:: machine
-.. _machine.Timer:
class Timer -- control internal timers
======================================
@@ -60,7 +59,7 @@ class Timer -- control internal timers
Constructors
------------
-.. class:: machine.Timer(id, ...)
+.. class:: Timer(id, ...)
.. only:: port_wipy
diff --git a/docs/library/machine.UART.rst b/docs/library/machine.UART.rst
index 594a11dce..27a880190 100644
--- a/docs/library/machine.UART.rst
+++ b/docs/library/machine.UART.rst
@@ -1,5 +1,4 @@
.. currentmodule:: machine
-.. _machine.UART:
class UART -- duplex serial communication bus
=============================================
@@ -59,7 +58,7 @@ Constructors
.. only:: port_wipy
- .. class:: machine.UART(bus, ...)
+ .. class:: UART(bus, ...)
Construct a UART object on the given bus. ``bus`` can be 0 or 1.
If the bus is not given, the default one will be selected (0) or the selection
diff --git a/docs/library/machine.WDT.rst b/docs/library/machine.WDT.rst
index 10e6af0e1..d7c801356 100644
--- a/docs/library/machine.WDT.rst
+++ b/docs/library/machine.WDT.rst
@@ -1,5 +1,4 @@
.. currentmodule:: machine
-.. _machine.WDT:
class WDT -- watchdog timer
===========================
@@ -18,7 +17,7 @@ Example usage::
Constructors
------------
-.. class:: machine.WDT(id=0, timeout=5000)
+.. class:: WDT(id=0, timeout=5000)
Create a WDT object and start it. The timeout must be given in seconds and
the minimum value that is accepted is 1 second. Once it is running the timeout
--
GitLab