fix typo in help text #7896

pull dooglus wants to merge 1 commits into bitcoin:master from dooglus:patch-1 changing 1 files +1 −1

dooglus commented at 8:35 PM on April 16, 2016: contributor

'in which the transaction is included in'

fix typo in help text

'in which the transaction is included in'

fc95f6ecb6

in src/rpc/rawtransaction.cpp:None in fc95f6ecb6
```
 210 | @@ -211,7 +211,7 @@ UniValue gettxoutproof(const UniValue& params, bool fHelp)
 211 |              "\nNOTE: By default this function only works sometimes. This is when there is an\n"
 212 |              "unspent output in the utxo for this transaction. To make it always work,\n"
 213 |              "you need to maintain a transaction index, using the -txindex command line option or\n"
 214 | -            "specify the block in which the transaction is included in manually (by blockhash).\n"
 215 | +            "specify the block in which the transaction is included manually (by blockhash).\n"
```
btcdrak commented at 8:43 PM on April 16, 2016:

maybe it needs a comma block in which the transaction is included in, manually. The whole sentence could do with being rewritten, it's very laboured language.

dooglus commented at 8:48 PM on April 16, 2016:

Maybe. My point is that the word 'in' is there twice and shouldn't be.

Either

"the block which the tx is included in"

or

"the block in which the tx is included"

are OK but

"the block in which the tx is included in"

isn't.

btcdrak commented at 9:03 PM on April 16, 2016:

Agreed. Overall the entire NOTE is painful for me to read.

Saying thing like "By default this function only works sometimes" and "To make it always work" is pretty strange. There must be a better way to express this note than flail about like that.

Just suggesting, while you are here editing a word, you might as well improve the whole NOTE.
dooglus commented at 9:22 PM on April 16, 2016:

NOTE: By default this function only works sometimes. This is when there is an unspent output in the utxo for this transaction. To make it always work, you need to maintain a transaction index, using the -txindex command line option or specify the block in which the transaction is included in manually (by blockhash).

I think this is what the note is trying to say:

This function only works when the transaction(s) can be located. Transactions can be located if any of these conditions are met:

the transaction has at least one unspent output

the transaction index is active (enabled using the -txindex command line option)

the optional blockhash parameter is provided and the corresponding block contains the transaction

Aside: why does the function accept multiple txids but only one blockhash? It appears that for this function to work all the transactions have to be in the same block. In which case it should be possible to find their containing block if any one of them has an unspent output. But the code appears to only attempt to look up the last specified txid. But this is way outside the scope of this typo-fixing issue!
jonasschnelli added the label Docs and Output on Apr 17, 2016
laanwj commented at 2:16 PM on April 19, 2016: member

Yes, let's improve the whole text, adding one word here is lipstick on a pig.
laanwj merged this on May 30, 2016
laanwj closed this on May 30, 2016
laanwj referenced this in commit 989df7ecf3 on May 30, 2016
codablock referenced this in commit 5dd1d8f321 on Sep 16, 2017
codablock referenced this in commit 659feb028d on Sep 19, 2017
codablock referenced this in commit a39b1f7b8d on Dec 21, 2017
andvgal referenced this in commit 9b9c466c2a on Jan 6, 2019
MarcoFalke locked this on Sep 8, 2021

Contributors

Labels