From c23ebcd2671cc010347e4a56b091ba3e26de0a04 Mon Sep 17 00:00:00 2001 From: MattHag <16444067+MattHag@users.noreply.github.com> Date: Sun, 2 Jun 2024 15:31:13 +0200 Subject: [PATCH] Use double quotes for module level docstrings Make module level docstrings distinguishable from license text. Related #2273 --- lib/hidapi/udev.py | 1 + lib/logitech_receiver/descriptors.py | 16 +++++++++------- lib/logitech_receiver/exceptions.py | 4 +--- lib/logitech_receiver/hidpp10_constants.py | 9 +++++---- 4 files changed, 16 insertions(+), 14 deletions(-) diff --git a/lib/hidapi/udev.py b/lib/hidapi/udev.py index 51547520..4f288c0a 100644 --- a/lib/hidapi/udev.py +++ b/lib/hidapi/udev.py @@ -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 diff --git a/lib/logitech_receiver/descriptors.py b/lib/logitech_receiver/descriptors.py index fb60f51c..0f5888ea 100644 --- a/lib/logitech_receiver/descriptors.py +++ b/lib/logitech_receiver/descriptors.py @@ -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 diff --git a/lib/logitech_receiver/exceptions.py b/lib/logitech_receiver/exceptions.py index 0f96276e..cc893fe8 100644 --- a/lib/logitech_receiver/exceptions.py +++ b/lib/logitech_receiver/exceptions.py @@ -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): diff --git a/lib/logitech_receiver/hidpp10_constants.py b/lib/logitech_receiver/hidpp10_constants.py index 7ce607cc..b9ce60a3 100644 --- a/lib/logitech_receiver/hidpp10_constants.py +++ b/lib/logitech_receiver/hidpp10_constants.py @@ -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,