BIP328: minor docstring fixups #1808

pull futreall wants to merge 1 commits into bitcoin:master from futreall:master changing 1 files +2 −2

futreall commented at 1:50 PM on April 1, 2025: contributor

2 doc-only fixups.

in bip-0328/_base58.py:56 in 351c3d5e5b outdated

  52 | @@ -53,7 +53,7 @@ def decode(s: str) -> bytes:
  53 |      """
  54 |      Decode a base58-encoding string, returning bytes
  55 |  
  56 | -    :param s: Base48 string to decode
  57 | +    :param s: Base58 string to decode

jonatack commented at 3:16 PM on April 1, 2025:

Looks like the following should be fixed as well:

@@ -118,7 +118,7 @@ def get_xpub_fingerprint_hex(xpub: str) -> str:
     """
     Get the parent fingerprint as a hex string from an extended public key
 
-    :param s: The extended pubkey
+    :param xpub: The extended pubkey
     :return: The parent fingerprint as a hex string

jonatack commented at 3:17 PM on April 1, 2025: member

ACK, see comment below for a similar one (please verify if you can find any others in the same BIP).
jonatack renamed this:
~~fix error `Base48` to `Base58` _base58.py~~
BIP328: minor docstring fixups
on Apr 1, 2025
futreall force-pushed on Apr 1, 2025
futreall commented at 3:29 PM on April 1, 2025: contributor

Done , there is no more such error in the files thanks
in bip-0328/_base58.py:110 in 81f0e56091 outdated
```
 106 | @@ -107,7 +107,7 @@ def get_xpub_fingerprint(s: str) -> bytes:
 107 |      """
 108 |      Get the parent fingerprint from an extended public key
 109 |  
 110 | -    :param s: The extended pubkey
 111 | +    :param xpub: The extended pubkey
```
jonatack commented at 4:03 PM on April 1, 2025:

It looks like this line should either remain as-is, or be updated to the name "xpub" in the code of this function.

jonatack commented at 6:05 PM on April 1, 2025:

In case I was unclear, the above comment was for this line only, not for #1808 (review).
jonatack commented at 4:04 PM on April 1, 2025: member

One comment on the latest push.
futreall force-pushed on Apr 1, 2025
futreall force-pushed on Apr 1, 2025
futreall commented at 5:48 PM on April 1, 2025: contributor

@jonatack I'll keep it as is

in bip-0328/_base58.py:56 in 587eef3ca2 outdated

  52 | @@ -53,7 +53,7 @@ def decode(s: str) -> bytes:
  53 |      """
  54 |      Decode a base58-encoding string, returning bytes
  55 |  
  56 | -    :param s: Base48 string to decode
  57 | +    :param s:Base58 string to decode

jonatack commented at 6:04 PM on April 1, 2025:

    :param s: Base58 string to decode

jonatack commented at 6:04 PM on April 1, 2025: member

Can you still address #1808 (review) for that one case?

fix error Base48 to Base58

chore: fix error Base48 to Base58

fix error Base48 to Base58

5772c6b40d

futreall force-pushed on Apr 1, 2025
futreall commented at 6:20 PM on April 1, 2025: contributor

Sorry, I wasn’t paying attention , now everything definitely worked out
jonatack commented at 7:13 PM on April 1, 2025: member

ACK 5772c6b40d102164e0e2387536ea5214e714a45d, thanks for updating.
jonatack merged this on Apr 1, 2025
jonatack closed this on Apr 1, 2025

Contributors

futreall

jonatack