Skip to content

Commit 74ce43e

Browse files
committed
final review of issue templates
1 parent 5e75f31 commit 74ce43e

File tree

2 files changed

+30
-28
lines changed

2 files changed

+30
-28
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,21 @@ body:
2222
> - [PlatformIO forums](https://community.platformio.org/)
2323
2424
We also host exhaustive [library documentation][docs].
25-
Please check the [API docs][api-docs] and/or [platform-specific pages][platform-pages] to see if your problem is described or addressed there.
26-
27-
Python users should migrate to using our [pyRF24](https://github.com/nRF24/pyRF24) python package.
28-
29-
<details><summary>The pyRF24 package has numerous advantages over the older/individual python wrapper(s)</summary>
30-
31-
- [x] [drop-in compatible](https://nrf24.github.io/pyRF24/#migrating-to-pyrf24)
32-
- [x] available via [`pip install pyrf24`](https://pypi.org/project/pyrf24/)
33-
- [x] no need to build from source and does not require the C++ libraries installed
34-
- [x] includes wrappers for RF24, RF24Network, RF24Mesh libraries and a fake BLE implementation
35-
- [x] includes typing stubs for type checking tools like mypy
36-
- [x] has [dedicated documentation](https://nrf24.github.io/pyRF24) and supports Python's builtin `help()` function
37-
38-
</details>
25+
Please check the [API documentation][api-docs] or [platform support pages][platform-pages] to see if your question is addressed there.
26+
27+
> [!important]
28+
> Python users should migrate to using our [pyRF24](https://github.com/nRF24/pyRF24) python package.
29+
>
30+
> <details><summary>The pyRF24 package has numerous advantages over the older/individual python wrapper(s)</summary>
31+
>
32+
> - [x] [drop-in compatible](https://nrf24.github.io/pyRF24/#migrating-to-pyrf24) API
33+
> - [x] available via [`pip install pyrf24`](https://pypi.org/project/pyrf24/)
34+
> - [x] no need to build from source and does not require the C++ libraries installed
35+
> - [x] includes wrappers for RF24, RF24Network, RF24Mesh libraries and a fake BLE implementation
36+
> - [x] includes typing stubs for type checking tools like mypy
37+
> - [x] has [dedicated documentation](https://nrf24.github.io/pyRF24) and supports Python's builtin `help()` function
38+
>
39+
> </details>
3940
4041
- type: input
4142
id: module

.github/ISSUE_TEMPLATE/question.yml

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,21 @@ body:
2424
> - [PlatformIO forums](https://community.platformio.org/)
2525
2626
We also host exhaustive [library documentation][docs].
27-
Please check the [API docs][api-docs] and/or [platform-specific pages][platform-pages] to see if your question is addressed there.
28-
29-
Python users should migrate to using our [pyRF24](https://github.com/nRF24/pyRF24) python package.
30-
31-
<details><summary>The pyRF24 package has numerous advantages over the older/individual python wrapper(s)</summary>
32-
33-
- [x] [drop-in compatible](https://nrf24.github.io/pyRF24/#migrating-to-pyrf24)
34-
- [x] available via [`pip install pyrf24`](https://pypi.org/project/pyrf24/)
35-
- [x] no need to build from source and does not require the C++ libraries installed
36-
- [x] includes wrappers for RF24, RF24Network, RF24Mesh libraries and a fake BLE implementation
37-
- [x] includes typing stubs for type checking tools like mypy
38-
- [x] has [dedicated documentation](https://nrf24.github.io/pyRF24) and supports Python's builtin `help()` function
39-
40-
</details>
27+
Please check the [API documentation][api-docs] or [platform support pages][platform-pages] to see if your question is addressed there.
28+
29+
> [!important]
30+
> Python users should migrate to using our [pyRF24](https://github.com/nRF24/pyRF24) python package.
31+
>
32+
> <details><summary>The pyRF24 package has numerous advantages over the older/individual python wrapper(s)</summary>
33+
>
34+
> - [x] [drop-in compatible](https://nrf24.github.io/pyRF24/#migrating-to-pyrf24) API
35+
> - [x] available via [`pip install pyrf24`](https://pypi.org/project/pyrf24/)
36+
> - [x] no need to build from source and does not require the C++ libraries installed
37+
> - [x] includes wrappers for RF24, RF24Network, RF24Mesh libraries and a fake BLE implementation
38+
> - [x] includes typing stubs for type checking tools like mypy
39+
> - [x] has [dedicated documentation](https://nrf24.github.io/pyRF24) and supports Python's builtin `help()` function
40+
>
41+
> </details>
4142
4243
- type: textarea
4344
id: user-question

0 commit comments

Comments
 (0)