doc: Fix doxygen comment for SignTransaction in rpc/rawtransaction_util #16900

pull MarcoFalke wants to merge 1 commits into bitcoin:master from MarcoFalke:1909-docRpcUtil changing 2 files +3 −3

MarcoFalke commented at 6:55 PM on September 17, 2019: member

The param coins to SignTransaction is final and can thus not be extended (as suggested by the doc).
MarcoFalke added the label Refactoring on Sep 17, 2019
MarcoFalke added the label Docs on Sep 17, 2019
laanwj commented at 12:45 PM on September 18, 2019: member

ACK fae8be06e7d54f70514cd5fa43423f79c2779e12

in src/rpc/rawtransaction_util.h:22 in fae8be06e7 outdated

  18 | @@ -19,11 +19,11 @@ class SigningProvider;
  19 |   *
  20 |   * @param  mtx           The transaction to-be-signed
  21 |   * @param  keystore      Temporary keystore containing signing keys
  22 | - * @param  coins         Map of unspent outputs - coins in mempool and current chain UTXO set, may be extended by previous txns outputs after call
  23 | + * @param  coins         Map of unspent outputs - coins in mempool and current chain UTXO set

promag commented at 2:09 PM on September 18, 2019:

Could just be "Map of unspent outputs" because "current chain" doesn't seem appropriate since the lock is not held?

promag commented at 2:09 PM on September 18, 2019: member

This was changed in #16798 39034f1ee628dae0bc9da5b1b30b8a424e66d968 where ParsePrevouts was extracted from SignTransaction.

ACK fae8be06e7d54f70514cd5fa43423f79c2779e12.
doc: Fix doxygen comment for SignTransaction in rpc/rawtransaction_util fa8d65f071
MarcoFalke force-pushed on Sep 19, 2019
MarcoFalke commented at 5:36 PM on September 19, 2019: member

Addressed feedback by @promag
MarcoFalke removed the label Refactoring on Sep 19, 2019
practicalswift commented at 9:31 PM on September 19, 2019: contributor

ACK fa8d65f07187590ae507c65a6dd63fd47b8d1fb3 -- const correctness is good and diff looks correct
fanquake approved
fanquake commented at 8:25 AM on September 20, 2019: member

ACK fa8d65f07187590ae507c65a6dd63fd47b8d1fb3
fanquake referenced this in commit 630ec7bf41 on Sep 20, 2019
fanquake merged this on Sep 20, 2019
fanquake closed this on Sep 20, 2019
jasonbcox referenced this in commit 96c54d32f2 on Oct 22, 2020
DrahtBot locked this on Dec 16, 2021

Contributors

Labels