From 74ce43ecdaa5a86e23d5e84bc23fc9995e755b14 Mon Sep 17 00:00:00 2001 From: Brendan <2bndy5@gmail.com> Date: Sun, 7 Jul 2024 17:09:46 -0700 Subject: [PATCH] final review of issue templates --- .github/ISSUE_TEMPLATE/bug-report.yml | 29 ++++++++++++++------------- .github/ISSUE_TEMPLATE/question.yml | 29 ++++++++++++++------------- 2 files changed, 30 insertions(+), 28 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index d7b68e5..87ba750 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -22,20 +22,21 @@ body: > - [PlatformIO forums](https://community.platformio.org/) We also host exhaustive [library documentation][docs]. - Please check the [API docs][api-docs] and/or [platform-specific pages][platform-pages] to see if your problem is described or addressed there. - - Python users should migrate to using our [pyRF24](https://github.com/nRF24/pyRF24) python package. - -
The pyRF24 package has numerous advantages over the older/individual python wrapper(s) - - - [x] [drop-in compatible](https://nrf24.github.io/pyRF24/#migrating-to-pyrf24) - - [x] available via [`pip install pyrf24`](https://pypi.org/project/pyrf24/) - - [x] no need to build from source and does not require the C++ libraries installed - - [x] includes wrappers for RF24, RF24Network, RF24Mesh libraries and a fake BLE implementation - - [x] includes typing stubs for type checking tools like mypy - - [x] has [dedicated documentation](https://nrf24.github.io/pyRF24) and supports Python's builtin `help()` function - -
+ Please check the [API documentation][api-docs] or [platform support pages][platform-pages] to see if your question is addressed there. + + > [!important] + > Python users should migrate to using our [pyRF24](https://github.com/nRF24/pyRF24) python package. + > + >
The pyRF24 package has numerous advantages over the older/individual python wrapper(s) + > + > - [x] [drop-in compatible](https://nrf24.github.io/pyRF24/#migrating-to-pyrf24) API + > - [x] available via [`pip install pyrf24`](https://pypi.org/project/pyrf24/) + > - [x] no need to build from source and does not require the C++ libraries installed + > - [x] includes wrappers for RF24, RF24Network, RF24Mesh libraries and a fake BLE implementation + > - [x] includes typing stubs for type checking tools like mypy + > - [x] has [dedicated documentation](https://nrf24.github.io/pyRF24) and supports Python's builtin `help()` function + > + >
- type: input id: module diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml index c184eed..f6d7a69 100644 --- a/.github/ISSUE_TEMPLATE/question.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -24,20 +24,21 @@ body: > - [PlatformIO forums](https://community.platformio.org/) We also host exhaustive [library documentation][docs]. - Please check the [API docs][api-docs] and/or [platform-specific pages][platform-pages] to see if your question is addressed there. - - Python users should migrate to using our [pyRF24](https://github.com/nRF24/pyRF24) python package. - -
The pyRF24 package has numerous advantages over the older/individual python wrapper(s) - - - [x] [drop-in compatible](https://nrf24.github.io/pyRF24/#migrating-to-pyrf24) - - [x] available via [`pip install pyrf24`](https://pypi.org/project/pyrf24/) - - [x] no need to build from source and does not require the C++ libraries installed - - [x] includes wrappers for RF24, RF24Network, RF24Mesh libraries and a fake BLE implementation - - [x] includes typing stubs for type checking tools like mypy - - [x] has [dedicated documentation](https://nrf24.github.io/pyRF24) and supports Python's builtin `help()` function - -
+ Please check the [API documentation][api-docs] or [platform support pages][platform-pages] to see if your question is addressed there. + + > [!important] + > Python users should migrate to using our [pyRF24](https://github.com/nRF24/pyRF24) python package. + > + >
The pyRF24 package has numerous advantages over the older/individual python wrapper(s) + > + > - [x] [drop-in compatible](https://nrf24.github.io/pyRF24/#migrating-to-pyrf24) API + > - [x] available via [`pip install pyrf24`](https://pypi.org/project/pyrf24/) + > - [x] no need to build from source and does not require the C++ libraries installed + > - [x] includes wrappers for RF24, RF24Network, RF24Mesh libraries and a fake BLE implementation + > - [x] includes typing stubs for type checking tools like mypy + > - [x] has [dedicated documentation](https://nrf24.github.io/pyRF24) and supports Python's builtin `help()` function + > + >
- type: textarea id: user-question