Documentation tweaks for spidev path, #37

doceme · Aug 22, 2016 · 11adf8c · 11adf8c
1 parent 3905188
commit 11adf8c
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -46,7 +46,7 @@ Methods
 
     open(bus, device)
 
-Connects to the specified SPI device, opening /dev/spidev-bus.device
+Connects to the specified SPI device, opening `/dev/spidev<bus>.<device>`
 
     readbytes(n)
 

diff --git a/spidev_module.c b/spidev_module.c
@@ -57,7 +57,7 @@ PyDoc_STRVAR(SpiDev_module_doc,
 typedef struct {
 	PyObject_HEAD
 
-	int fd;	/* open file descriptor: /dev/spi-X.Y */
+	int fd;	/* open file descriptor: /dev/spidevX.Y */
 	uint8_t mode;	/* current SPI mode */
 	uint8_t bits_per_word;	/* current SPI bits per word setting */
 	uint32_t max_speed_hz;	/* current SPI max speed setting in Hz */
@@ -889,7 +889,7 @@ static PyGetSetDef SpiDev_getset[] = {
 PyDoc_STRVAR(SpiDev_open_doc,
 	"open(bus, device)\n\n"
 	"Connects the object to the specified SPI device.\n"
-	"open(X,Y) will open /dev/spidev-X.Y\n");
+	"open(X,Y) will open /dev/spidev<X>.<Y>\n");
 
 static PyObject *
 SpiDev_open(SpiDevObject *self, PyObject *args, PyObject *kwds)