bitshares / bitshares-core

BitShares Blockchain node and command-line wallet
https://bitshares.github.io/
Other
1.17k stars 647 forks source link

`gethelp` command in CLI wallet built with Ubuntu 20 lacks docs for command parameters #2770

Closed abitmore closed 1 year ago

abitmore commented 1 year ago

Bug Description

CLI wallet built with Ubuntu 18.04 (with doxygen 1.8.13) or Ubuntu 16.04 (with doxygen 1.8.11):

>>> gethelp transfer

Transfer an amount from one account to another.

Parameters:
    from: the name or id of the account sending the funds (type: string)
    to: the name or id of the account receiving the funds (type: string)
    amount: the amount to send (in nominal units - to send half of a BTS,
        specify 0.5) (type: string)
    asset_symbol_or_id: the symbol or id of the asset to send (type:
        string)
    memo: a memo to attach to the transaction. The memo will be encrypted
        in the transaction and readable for the receiver. There is no
        length limit other than the limit imposed by maximum transaction
        size, but transaction increase with transaction size (type: string)
    broadcast: true to broadcast the transaction on the network (type:
        bool)

Returns
    the signed transaction transferring funds

usage: transfer FROM TO AMOUNT SYMBOL "memo" BROADCAST

example: transfer "1.3.11" "1.3.4" 1000.03 CORE "memo" true
example: transfer "usera" "userb" 1000.123 CORE "memo" true

CLI wallet built with Ubuntu 20.04 (with doxygen 1.8.17):

>>> gethelp transfer

Transfer an amount from one account to another.

Returns
    the signed transaction transferring funds

usage: transfer FROM TO AMOUNT SYMBOL "memo" BROADCAST

example: transfer "1.3.11" "1.3.4" 1000.03 CORE "memo" true
example: transfer "usera" "userb" 1000.123 CORE "memo" true

Both have doxygen installed, with different versions though.

Impacts Describe which portion(s) of BitShares Core may be impacted by this bug. Please tick at least one box.

CORE TEAM TASK LIST

abitmore commented 1 year ago

Fixed by #2771.