Skip to content

Commit 4c988e0

Browse files
committed
Minor doc updates
1 parent 23dc088 commit 4c988e0

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

lib/i2c.ex

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -182,18 +182,19 @@ defmodule Circuits.I2C do
182182
end
183183

184184
@doc """
185-
close the I2C bus
185+
Close the I2C bus
186186
"""
187187
@spec close(Bus.t()) :: :ok
188188
def close(bus) do
189189
Bus.close(bus)
190190
end
191191

192192
@doc """
193-
Return a list of available I2C bus names. If nothing is returned, it's
194-
possible that the kernel driver for that I2C bus is not enabled or the
195-
kernel's device tree is not configured. On Raspbian, run `raspi-config` and
196-
look in the advanced options.
193+
Return a list of available I2C bus names
194+
195+
If nothing is returned, it's possible that the kernel driver for that I2C bus
196+
is not enabled or the kernel's device tree is not configured. On Raspbian,
197+
run `raspi-config` and look in the advanced options.
197198
198199
```elixir
199200
iex> Circuits.I2C.bus_names()
@@ -207,8 +208,10 @@ defmodule Circuits.I2C do
207208
end
208209

209210
@doc """
210-
Scan the I2C bus for devices by performing a read at each device address and
211-
returning a list of device addresses that respond.
211+
Scan the I2C bus for devices
212+
213+
Since there's no official way of enumerating I2C devices, this attempts to
214+
figure out what's on the bus by seeing what devices respond.
212215
213216
```elixir
214217
iex> Circuits.I2C.detect_devices("i2c-1")

0 commit comments

Comments
 (0)