Skip to content

Commit 714baef

Browse files
authored
Merge pull request adafruit#15 from adafruit/dherrada-patch-1
Made README.rst renderable by PyPI
2 parents f54e571 + 76f76ae commit 714baef

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,20 +72,20 @@ You'll need to dedicate two pins to communicating with the HC-SR04. The sensor c
7272
manner, so it doesn't matter which pins you choose, as long as they're digital IO pins (pins that start with "``D``"
7373
are digital).
7474

75-
There are two ways of instantiating a :class:`~hcsr04.HCSR04` object: with or without using a context manager.
75+
There are two ways of instantiating a `HCSR04` object: with or without using a context manager.
7676

7777
.. note::
7878

7979
It is technically possible to communicate with the HC-SR04 using only one wire since the trigger and echo signals
8080
aren't ever active at the same time. Once I have a chance to determine a safe way to do this, I plan to add this as
8181
a feature to the library.
8282

83-
.. seealso::
83+
See Also:
8484

8585
`Adafruit's guide on Lifetime and ContextManagers <https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html#lifetime-and-contextmanagers>`_
8686
Gives more info on using context managers with CircuitPython drivers.
8787

88-
:any:`board`
88+
`board <https://circuitpython.readthedocs.io/en/latest/shared-bindings/board/__init__.html#module-board>`_
8989
A list of pins available on your device. To view this list, first `get a REPL
9090
<http://circuitpython.readthedocs.io/en/latest/docs/pyboard/tutorial/repl.html>`_ (the guide linked was written
9191
for the pyboard, but it still works), then input the following:
@@ -98,7 +98,7 @@ There are two ways of instantiating a :class:`~hcsr04.HCSR04` object: with or wi
9898
Without a Context Manager
9999
-------------------------
100100

101-
In the example below, we create the :class:`~hcsr04.HCSR04` object directly, get the distance every 2 seconds, then
101+
In the example below, we create the `HCSR04` object directly, get the distance every 2 seconds, then
102102
de-initialize the device.
103103

104104
::
@@ -117,7 +117,7 @@ de-initialize the device.
117117
With a Context Manager
118118
----------------------
119119

120-
In the example below, we use a context manager (the :any:`with <with>` statement) to create the :class:`~hcsr04.HCSR04`
120+
In the example below, we use a context manager (the `with <https://docs.python.org/3.4/reference/compound_stmts.html#with>`_ statement) to create the `HCSR04`
121121
instance, again get the distance every 2 seconds, but then the context manager handles de-initializing the device for
122122
us.
123123

0 commit comments

Comments
 (0)