Use double quotes for module level docstrings

Make module level docstrings distinguishable from license text.

Related #2273
This commit is contained in:
MattHag 2024-06-02 15:31:13 +02:00 committed by Peter F. Patel-Schneider
parent 5a63e44d58
commit c23ebcd267
4 changed files with 16 additions and 14 deletions

View File

@ -13,6 +13,7 @@
## You should have received a copy of the GNU General Public License along
## with this program; if not, write to the Free Software Foundation, Inc.,
## 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
"""Generic Human Interface Device API.
It is currently a partial pure-Python implementation of the native HID API

View File

@ -14,13 +14,15 @@
## with this program; if not, write to the Free Software Foundation, Inc.,
## 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Devices (not receivers) known to Solaar.
# Solaar can handle many recent devices without having any entry here.
# An entry should only be added to fix problems, such as
# - the device's device ID or WPID falls outside the range that Solaar searches
# - the device uses a USB interface other than 2
# - the name or codename should be different from what the device reports
"""Devices (not receivers) known to Solaar.
Solaar can handle many recent devices without having any entry here.
An entry should only be added to fix problems, such as
- the device's device ID or WPID falls outside the range that Solaar searches
- the device uses a USB interface other than 2
- the name or codename should be different from what the device reports
"""
from .hidpp10_constants import DEVICE_KIND
from .hidpp10_constants import REGISTERS as REG

View File

@ -17,9 +17,7 @@
from .common import KwException
#
# Exceptions that may be raised by this API.
#
"""Exceptions that may be raised by this API."""
class NoReceiver(KwException):

View File

@ -17,10 +17,11 @@
from .common import NamedInts
#
# Constants - most of them as defined by the official Logitech HID++ 1.0
# documentation, some of them guessed.
#
"""HID constants for HID++ 1.0.
Most of them as defined by the official Logitech HID++ 1.0
documentation, some of them guessed.
"""
DEVICE_KIND = NamedInts(
unknown=0x00,