Merge #594: Fix support matrix table

db5a0bb Fix docs warning about end strings (Andrew Chow) a7e8ea7 Fix support matrix table (Andrew Chow) Pull request description: Misaligned whitespace is causing the table to not be rendered at all. Top commit has no ACKs. Tree-SHA512: 461f3c2f51ada270a6e375eb20271a16997608d10227a3dc25576c05530cfb1a81f7a4a0ed130230733639c0b9480586902e8ee9fc7983705e3b48c8fc5c1c48
bitcoin-core · Apr 12, 2022 · 5af70ba · 5af70ba
2 parents f002150 + db5a0bb
commit 5af70ba
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 50 deletions.
diff --git a/docs/devices/index.rst b/docs/devices/index.rst
@@ -10,53 +10,53 @@ The table below lists what devices and features are supported for each device.
 * ``✗`` - supported by the firmware and not implemented in HWI
 * ``―`` - not supported by the firmware
 
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| Feature \\ Device                  | Ledger Nano X | Ledger Nano S | Trezor One | Trezor Model T | BitBox01 | BitBox02 | KeepKey | Coldcard | Blockstream Jade |
-+====================================+===============+===============+============+================+==========+==========+=========+==========+==================+
-| Support Planned                    | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| Implemented                        | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| xpub retrieval                     | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| Message Signing                    | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| Device Setup                       | ―             | ―             | ✓          | ✓              | ✓        | ✓        | ✓       | ―        | ―                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| Device Wipe                        | ―             | ―             | ✓          | ✓              | ✓        | ✓        | ✓       | ―        | ―                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| Device Recovery                    | ―             | ―             | ✓          | ✓              | ―        | ✓        | ✓       | ―        | ―                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| Device Backup                      | ―             | ―             | ―          | ―              | ✓        | ✓        | ―       | ✓        | ―                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| P2PKH Inputs                       | ✓             | ✓             | ✓          | ✓              | ✓        | ―        | ✓       | ✓        | ✓                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| P2SH-P2WPKH Inputs                 | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| P2WPKH Inputs                      | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| P2SH Multisig Inputs               | ✓             | ✓             | ✓          | ✓              | ✓        | ―        | ✓       | ✓        | ✓                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| P2SH-P2WSH Multisig Inputs         | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| P2WSH Multisig Inputs              | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| Bare Multisig Inputs               | ✓             | ✓             | ―          | ―              | ✓        | ―        | ―       | ―        | ✓                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| Taproot Inputs                     | ✓*            | ✓*            | ✓*         | ✓*             |  ―       | ―        | ―       | ―        | ―                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| Arbitrary scriptPubKey Inputs      | ✓             | ✓             | ―          | ―              | ✓        | ―        | ―       | ―        | ✓                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| Arbitrary redeemScript Inputs      | ✓             | ✓             | ―          | ―              | ✓        | ―        | ―       | ―        | ✓                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| Arbitrary witnessScript Inputs     | ✓             | ✓             | ―          | ―              | ✓        | ―        | ―       | ―        | ✓                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| Non-wallet inputs                  | ✓             | ✓             | ✗\ :sup:`1` | ✗\ :sup:`2`    | ✓        | ―        | ✓       | ✓        | ✓                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| Mixed Segwit and Non-Segwit Inputs | ―             | ―             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
-| Display on device screen           | ✓             | ✓             | ✓          | ✓              | ―        | ✓        | ✓       | ✓        | ✓                |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| Feature \\ Device                  | Ledger Nano X | Ledger Nano S | Trezor One   | Trezor Model T | BitBox01 | BitBox02 | KeepKey | Coldcard | Blockstream Jade |
++====================================+===============+===============+==============+================+==========+==========+=========+==========+==================+
+| Support Planned                    | ✓             | ✓             | ✓            | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| Implemented                        | ✓             | ✓             | ✓            | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| xpub retrieval                     | ✓             | ✓             | ✓            | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| Message Signing                    | ✓             | ✓             | ✓            | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| Device Setup                       | ―             | ―             | ✓            | ✓              | ✓        | ✓        | ✓       | ―        | ―                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| Device Wipe                        | ―             | ―             | ✓            | ✓              | ✓        | ✓        | ✓       | ―        | ―                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| Device Recovery                    | ―             | ―             | ✓            | ✓              | ―        | ✓        | ✓       | ―        | ―                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| Device Backup                      | ―             | ―             | ―            | ―              | ✓        | ✓        | ―       | ✓        | ―                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| P2PKH Inputs                       | ✓             | ✓             | ✓            | ✓              | ✓        | ―        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| P2SH-P2WPKH Inputs                 | ✓             | ✓             | ✓            | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| P2WPKH Inputs                      | ✓             | ✓             | ✓            | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| P2SH Multisig Inputs               | ✓             | ✓             | ✓            | ✓              | ✓        | ―        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| P2SH-P2WSH Multisig Inputs         | ✓             | ✓             | ✓            | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| P2WSH Multisig Inputs              | ✓             | ✓             | ✓            | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| Bare Multisig Inputs               | ✓             | ✓             | ―            | ―              | ✓        | ―        | ―       | ―        | ✓                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| Taproot Inputs                     | ✓*            | ✓*            | ✓*           | ✓*             |  ―       | ―        | ―       | ―        | ―                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| Arbitrary scriptPubKey Inputs      | ✓             | ✓             | ―            | ―              | ✓        | ―        | ―       | ―        | ✓                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| Arbitrary redeemScript Inputs      | ✓             | ✓             | ―            | ―              | ✓        | ―        | ―       | ―        | ✓                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| Arbitrary witnessScript Inputs     | ✓             | ✓             | ―            | ―              | ✓        | ―        | ―       | ―        | ✓                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| Non-wallet inputs                  | ✓             | ✓             | ✗\ :sup:`1`  | ✗\ :sup:`2`    | ✓        | ―        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| Mixed Segwit and Non-Segwit Inputs | ―             | ―             | ✓            | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
+| Display on device screen           | ✓             | ✓             | ✓            | ✓              | ―        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+--------------+----------------+----------+----------+---------+----------+------------------+
 
 * 1 - Support removed for devices with firmware 1.10.6 and greater.
 * 2 - Support removed for devices with firmware 2.4.4 and greater.

diff --git a/hwilib/descriptor.py b/hwilib/descriptor.py
@@ -222,7 +222,7 @@ def __init__(
     ) -> None:
         r"""
         :param pubkeys: The :class:`PubkeyProvider`\ s that are part of this descriptor
-        :param subdescriptor: The ``Descriptor``s that are part of this descriptor
+        :param subdescriptor: The ``Descriptor``\ s that are part of this descriptor
         :param name: The name of the function for this descriptor
         """
         self.pubkeys = pubkeys
@@ -397,9 +397,9 @@ def __init__(
         subdescriptors: List['Descriptor'] = [],
         depths: List[int] = []
     ) -> None:
-        """
+        r"""
         :param internal_key: The :class:`PubkeyProvider` that is the internal key for this descriptor
-        :param subdescriptors: The :class:`Descriptor`s that are the leaf scripts for this descriptor
+        :param subdescriptors: The :class:`Descriptor`\ s that are the leaf scripts for this descriptor
         :param depths: The depths of the leaf scripts in the same order as `subdescriptors`
         """
         super().__init__([internal_key], subdescriptors, "tr")