doc: Add missing optional to getblockfrompeer #23702

pull MarcoFalke wants to merge 1 commits into bitcoin:master from MarcoFalke:2112-docOpt changing 1 files +17 −16

MarcoFalke commented at 10:40 AM on December 8, 2021: member

Can be reviewed with --word-diff-regex=. --ignore-all-space
doc: Add missing optional to getblockfrompeer aaaa34e34d
MarcoFalke commented at 10:41 AM on December 8, 2021: member

Needed for #23083
MarcoFalke cross-referenced this on Dec 8, 2021 from issue rpc: getblockfrompeer by Sjors
Sjors commented at 11:38 AM on December 8, 2021: member

utACK aaaa34e34db6ff0f9ca3407bda42e7f0db887737
DrahtBot added the label RPC/REST/ZMQ on Dec 8, 2021
MarcoFalke merged this on Dec 8, 2021
MarcoFalke closed this on Dec 8, 2021
MarcoFalke deleted the branch on Dec 8, 2021
MarcoFalke added the label Docs on Dec 8, 2021
in src/rpc/blockchain.cpp:784 in aaaa34e34d
```
 795 | -                },
 796 | +    return RPCHelpMan{
 797 | +        "getblockfrompeer",
 798 | +        "\nAttempt to fetch block from a given peer.\n"
 799 | +        "\nWe must have the header for this block, e.g. using submitheader.\n"
 800 | +        "\nReturns {} if a block-request was successfully scheduled\n",
```
jonatack commented at 12:33 PM on December 8, 2021:

- "\nReturns {} if a block-request was successfully scheduled\n", + "\nReturns {} if a block-request was successfully scheduled.\n",
MarcoFalke commented at 12:40 PM on December 8, 2021:

The trailing newline isn't needed either. Whitespace will be normalized by the doc generator.

Sjors commented at 1:28 PM on December 8, 2021:

I added the . in #23706, but I was not able to drop the trailing \n without messing up the formatting of bitcoin-cli help getblockfrompeer.

MarcoFalke commented at 6:06 PM on December 8, 2021:

Sorry, I never implemented this. Done in https://github.com/bitcoin/bitcoin/pull/23714
jonatack commented at 12:34 PM on December 8, 2021: contributor

Post-merge ACK, one nit for any follow-ups.
sidhujag referenced this in commit 9b29fd36ba on Dec 8, 2021
luke-jr referenced this in commit 03d1e73049 on Dec 14, 2021
RandyMcMillan referenced this in commit 897fda0730 on Dec 23, 2021
Fabcien referenced this in commit 93ae2058ec on Dec 3, 2022
bitcoin locked this on Dec 8, 2022

Contributors

Labels

Linked (view graph)

#20295 rpc: getblockfrompeer #23083 rpc: Fail to return undocumented or misdocumented JSON #23706 rpc: getblockfrompeer followups #23714 doc: Normalize RPC description whitespace