developer.bitcoin.org icon indicating copy to clipboard operation
developer.bitcoin.org copied to clipboard

Published 20 hours ago • verified publisher icon bitcoin-dot-org

[RPC] createwallet: cralify docs

Open ratijas opened this issue 5 years ago • 3 comments

Documentation for the createwallet RPC call is somewhat incomplete.

First, description section does not match with result section for Argument #1 - wallet_name: one mentions "path location" and while the other refers to "full path".

Second, what is the definition of a path? How RPC knows if it is a path or not? E.g. from inclusion of slashes (/ or \) in the string?

Finally, what about relative paths, like ./mywallet?

Also, consider adding an example of using path notation.

  • https://developer.bitcoin.org/reference/rpc/createwallet.html
  • https://github.com/bitcoin-dot-org/developer.bitcoin.org/blob/master/reference/rpc/createwallet.rst

ratijas avatar Jul 13 '20 09:07 ratijas

The documentation is taken from the command line help which is defined in the sources of Bitcoin Core. Best would be to fix it there: https://github.com/bitcoin/bitcoin/blob/4db44acf2d5d3b40943c94b3960f42838255b7ad/src/wallet/rpcwallet.cpp#L2592

cornelius avatar Jul 14 '20 17:07 cornelius

@cornelius Shall I transfer the issue, or it will be taken care of?

ratijas avatar Jul 14 '20 18:07 ratijas

@ratijas Feel free to transfer the issue. I don't think the Bitcoin Core developers will see it here.

cornelius avatar Jul 20 '20 19:07 cornelius