diff --git a/docs/Makefile b/docs/Makefile index b2cad44..2f982e2 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -85,17 +85,17 @@ qthelp: @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pyad2usb.qhcp" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pyad2.qhcp" @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pyad2usb.qhc" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pyad2.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/pyad2usb" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pyad2usb" + @echo "# mkdir -p $$HOME/.local/share/devhelp/pyad2" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pyad2" @echo "# devhelp" epub: diff --git a/docs/index.rst b/docs/index.rst index 9b9e2c4..1acdb0d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,4 +1,4 @@ -.. pyad2usb documentation master file, created by +.. pyad2 documentation master file, created by sphinx-quickstart on Sat Jun 8 14:38:46 2013. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. diff --git a/docs/make.bat b/docs/make.bat index 6ded9e3..17f9eef 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -115,9 +115,9 @@ if "%1" == "qthelp" ( echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pyad2usb.qhcp + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pyad2.qhcp echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pyad2usb.ghc + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pyad2.ghc goto end ) diff --git a/pyad2/ad2.py b/pyad2/ad2.py index 4a0b119..c767437 100644 --- a/pyad2/ad2.py +++ b/pyad2/ad2.py @@ -1,5 +1,5 @@ """ -Provides the full AD2USB class and factory. +Provides the full AD2 class and factory. .. moduleauthor:: Scott Petersen """ @@ -171,7 +171,7 @@ class Overseer(object): class AD2(object): """ - High-level wrapper around AD2USB/AD2SERIAL devices. + High-level wrapper around AD2 devices. """ # High-level Events @@ -219,7 +219,7 @@ class AD2(object): """ Constructor - :param device: The low-level device used for this AD2USB interface. + :param device: The low-level device used for this AD2 interface. :type device: devices.Device """ self._device = device @@ -245,7 +245,7 @@ class AD2(object): @property def id(self): """ - The ID of the AD2USB device. + The ID of the AD2 device. :returns: The identification string for the device. """ diff --git a/pyad2/devices.py b/pyad2/devices.py index af74a67..243f796 100644 --- a/pyad2/devices.py +++ b/pyad2/devices.py @@ -1,5 +1,5 @@ """ -Contains different types of devices belonging to the AD2USB family. +Contains different types of devices belonging to the AD2 family. .. moduleauthor:: Scott Petersen """ @@ -17,7 +17,7 @@ from .event import event class Device(object): """ - Generic parent device to all AD2USB products. + Generic parent device to all AD2 products. """ # Generic device events @@ -610,7 +610,7 @@ class SerialDevice(Device): class SocketDevice(Device): """ - Device that supports communication with an AD2USB that is exposed via ser2sock or another + Device that supports communication with an AD2 that is exposed via ser2sock or another Serial to IP interface. """ diff --git a/pyad2/messages.py b/pyad2/messages.py index 36b29e6..bd693e2 100644 --- a/pyad2/messages.py +++ b/pyad2/messages.py @@ -1,5 +1,5 @@ """ -Message representations received from the panel through the AD2USB. +Message representations received from the panel through the AD2 devices. .. moduleauthor:: Scott Petersen """ diff --git a/pyad2/util.py b/pyad2/util.py index ab94bc8..60ba88a 100644 --- a/pyad2/util.py +++ b/pyad2/util.py @@ -1,5 +1,5 @@ """ -Provides utility classes for the AD2USB devices. +Provides utility classes for the AD2 devices. .. moduleauthor:: Scott Petersen """ @@ -35,7 +35,7 @@ class InvalidMessageError(Exception): class Firmware(object): """ - Represents firmware for the AD2USB/AD2SERIAL devices. + Represents firmware for the AD2 devices. """ # Constants @@ -49,7 +49,7 @@ class Firmware(object): @staticmethod def upload(dev, filename, progress_callback=None): """ - Uploads firmware to an AD2USB/AD2SERIAL device. + Uploads firmware to an AD2 device. :param filename: The firmware filename :type filename: str