From d4ae04818b99b0686c125d5bd2e19e0b092af9b3 Mon Sep 17 00:00:00 2001 From: Julian-o Date: Thu, 7 Dec 2023 14:58:16 +1100 Subject: [PATCH] Review comments --- CONTACT.md | 12 ++++++------ FAQ.md | 4 ++-- README.md | 11 ++++++----- docs/source/conf.py | 6 +++--- docs/source/contact.rst | 2 +- docs/source/index.rst | 6 +++--- setup.py | 5 ++--- 7 files changed, 23 insertions(+), 23 deletions(-) diff --git a/CONTACT.md b/CONTACT.md index 337d75cc..a98bb331 100644 --- a/CONTACT.md +++ b/CONTACT.md @@ -1,8 +1,8 @@ -# Contacting the Kivy Team +.. _contact: -Are you having trouble using the Kivy framework, or any of its related projects? -Is there an error you don’t understand? Are you trying to figure out how to use -it? We have volunteers who can help! +Contact Us +========== -The best channels to contact us for support are listed in the latest -[Contact Us](https://github.com/kivy/kivy/blob/master/CONTACT.md) document. +If you are looking to contact the Kivy Team (who are responsible for managing the +Plyer project), including looking for support, please see our +`latest contact details `_. \ No newline at end of file diff --git a/FAQ.md b/FAQ.md index f22c29b1..8d6ee2ed 100644 --- a/FAQ.md +++ b/FAQ.md @@ -2,8 +2,8 @@ ## Introduction -Plyer is a platform-independent Python API for accessing features -of various hardware platforms, especially Android and iOS devices. +Plyer is a platform-independent Python API for accessing hardware features +of various platforms (Android, iOS, macOS, Linux and Windows). Plyer is managed by the [Kivy Team](https://kivy.org/about.html). It is suitable for use with Kivy apps, but can be used independently. diff --git a/README.md b/README.md index 285cc1a5..0afa8a51 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Plyer -Plyer is a platform-independent Python API for accessing features -of various hardware platforms, especially Android and iOS devices. +Plyer is a platform-independent Python API for accessing hardware features +of various platforms (Android, iOS, macOS, Linux and Windows). Plyer is managed by the [Kivy Team](https://kivy.org/about.html). It is suitable for use with Kivy apps, but can be used independently. @@ -28,9 +28,10 @@ Plyer tries not to reinvent the wheel, and will call external libraries to implement the API in the easiest way, depending on the current platform. - On Android ([python-for-android](https://python-for-android.readthedocs.io/)), [PyJNIus](https://pypi.org/project/pyjnius/) is used. -- On iOS ([kivy-ios](https://pypi.org/project/kivy-ios/)), [pyobjus](https://pypi.org/project/pyobjus/) is used. -- On Windows, macOS and Linux, commonly found libraries and programs will be -used. +- On iOS ([kivy-ios](https://pypi.org/project/kivy-ios/)) and macOS, + [pyobjus](https://pypi.org/project/pyobjus/) is used. +- On Windows, macOS and Linux, other commonly found libraries and programs + are used. ## Supported APIs diff --git a/docs/source/conf.py b/docs/source/conf.py index fb7b4c10..10c243a3 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -43,7 +43,7 @@ # General information about the project. project = u'Plyer' -copyright = u'2013-2024, Kivy Team and other contributors' +copyright = u'2013-2023, Kivy Team and other contributors' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -235,8 +235,8 @@ 'index', 'Plyer', u'Plyer Documentation', u'Kivy Team and other contributors', 'Plyer', - 'Plyer is a platform-independent Python API for accessing features of ' - 'various hardware platforms, especially Android and iOS devices.', + 'Plyer is a platform-independent Python API for accessing hardware features' + 'of various platforms (Android, iOS, macOS, Linux and Windows).', 'Miscellaneous' ), ] diff --git a/docs/source/contact.rst b/docs/source/contact.rst index a98bb331..d57f1ebe 100644 --- a/docs/source/contact.rst +++ b/docs/source/contact.rst @@ -5,4 +5,4 @@ Contact Us If you are looking to contact the Kivy Team (who are responsible for managing the Plyer project), including looking for support, please see our -`latest contact details `_. \ No newline at end of file +`latest contact details `_. \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 937a3d2d..57893003 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,14 +1,14 @@ Welcome to Plyer ================ -Plyer is a platform-independent Python API for accessing features -of various hardware platforms, especially Android and iOS devices. +Plyer is a platform-independent Python API for accessing hardware features +of various platforms (Android, iOS, macOS, Linux and Windows). Plyer is managed by the `Kivy Team ` and is suitable for use with Kivy apps. Plyer is released and distributed under the terms of the MIT license. Our -`latest license `_ +`latest license `_ is available. .. toctree:: diff --git a/setup.py b/setup.py index f9a21f30..80f65af7 100644 --- a/setup.py +++ b/setup.py @@ -56,9 +56,8 @@ setup( name='plyer', version=plyer.__version__, - description='A platform-independent Python API for accessing features of ' - 'various hardware platforms, especially Android and iOS ' - 'devices.', + description='A platform-independent Python API for accessing hardware' + 'features of various platforms (Android, iOS, macOS, Linux and Windows).', long_description=README + u"\n\n" + CHANGELOG + u"\n\n", long_description_content_type='text/markdown', author='Kivy team',